#I was looking at annotations (e.g., @blablahblagh), what is this?

1 messages · Page 1 of 1 (latest)

nimble vector
#

In the image, at the bottom of the section, it says this. What does this mean?

@ClassPreamble was this is its needed :

   String author();
   String date();
   int currentRevision() default 1;
   String lastModified() default "N/A";
   String lastModifiedBy() default "N/A";
   // Note use of array
   String[] reviewers();
}```
image.png
vague sigilBOT
#

<@&987246399047479336> please have a look, thanks.

vague sigilBOT
#

While you are waiting for getting help, here are some tips to improve your experience:

Code is much easier to read if posted with syntax highlighting and proper formatting.

If nobody is calling back, that usually means that your question was not well asked and hence nobody feels confident enough answering. Try to use your time to elaborate, provide details, context, more code, examples and maybe some screenshots. With enough info, someone knows the answer for sure.

Don't forget to close your thread using the command </help-thread close:1027500463647621170> when your question has been answered, thanks.

#

Here is an AI assisted attempt to answer your question 🤖. Maybe it helps! In any case, a human is on the way 👍. To continue talking to the AI, you can use </chatgpt:1108714622413963314>.

#

In Java, annotations are a form of metadata that can be added to code elements such as classes, methods, fields, and parameters. They provide additional information about the code and can be used by the compiler or other tools for various purposes.

The "@blablahblagh" you mentioned is an example of an annotation. It represents a specific annotation type that has been defined in the codebase. Annotations are typically prefixed with the "@" symbol to distinguish them from other code elements.

The meaning and purpose of the "@blablahblagh" annotation would depend on how it has been implemented in the codebase. Annotations can serve different purposes such as providing instructions to the compiler, enabling runtime behaviors, documenting code, or being used by external tools for analysis or code generation.

To understand what this specific annotation does, you would need to refer to the documentation or source code of the project you are working on.

#

I was looking at annotations (e.g., @blablahblagh), what is this?

#

Changed the title to I was looking at annotations (e.g., @blablahblagh), what is this?.

golden gust
#

In Java, annotations are a form of metadata that can be added to code elements such as classes, methods, fields, and parameters. They provide additional information about the code and can be used by the compiler or other tools for various purposes.

on top of it, from a quick search @Documented is used to ensure custom annotations are displayed in generated docs. Without it, it will be ignored by whatever tool you're using to create em.

nimble vector
still sleet
# nimble vector what is the javadoc? 
/**
 * Javadocs are the documentation for methods, fields, and classes in comments like this.
 * Note that there are two stars at the start and that the javadoc comment of something has to be placed directly before it.
 */
golden gust
#

I never wrote em myself, but it's just documentation with certain standards that are also used by java. Documentation is way to give information about your method/classes etc which will can be used by someone to work with it. What this method does, what can be passed or what are the exceptions etc etc.

nimble vector
#

But its not compulsory

golden gust
#

if it's a personal project maybe not, if its required by your assignment then you prolly need to.

#

If you expect someone will use your project, then maybe yes.

raven flicker
#

I can make an example

nimble vector
#

But if i do somehow need to work with someone

#

I will come back to this subject

#

thanks

golden gust
nimble vector
#

toodles!

vague sigilBOT
#

Closed the thread.

raven flicker
#

they are useful for documentation but also as runtime hooks for reflection