Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Is there a way to write a single line javadoc comment, like in doxygen /**<*/

Tags:

javadoc

I would like to comment a variable like I used to do in doxygen and I wonder if there is a way to comment variables after declaring them in the same line. (I've never used javadoc before =/ ).

like image 697
Victor Avatar asked Jan 01 '14 14:01

Victor


People also ask

How do you write a Javadoc style comment?

Writing Javadoc Comments In general, Javadoc comments are any multi-line comments (" /** ... */ ") that are placed before class, field, or method declarations. They must begin with a slash and two stars, and they can include special tags to describe characteristics like method parameters or return values.

How do I add comments to a Javadoc class?

Adding JavaDoc comments The basic rule for creating JavaDoc comments is that they begin with /** and end with */. You can place JavaDoc comments in any of three different locations in a source file: Immediately before the declaration of a public class. Immediately before the declaration of a public field.

How do I create an automatic Javadoc?

In the Package Explorer view, select a Java project and click Project > Generate Javadoc with Diagrams > Automatically. In the Generate Javadoc wizard, under Javadoc command, select the Javadoc command (an executable file). Note: Only Oracle JDK Version 1.4.

Which character is used when using a Javadoc comment?

Javadoc Comments A Javadoc comment begins with a forward slash followed by two star characters: /** and ends with a start character followed by a forward slash: */ . A Javadoc comment must appear immediately before the declaration of any class, interface, constructor, method, or field that the comment describes.


1 Answers

Yes, you can use /** comment */.

like image 133
Vasil Lukach Avatar answered Oct 05 '22 03:10

Vasil Lukach