: beginner: I pointed out every time in the source review of newcomer training, so I organized it for newcomers: beginner:
//comment
With eclipse, you can put it in and out with ctrl + /.
/*
*One asterisk at the beginning
* comment
*/
JavaDoc
/**
*Class or method description
*There are two asterisks at the beginning.
*/
A special comment with a different nature from the two mentioned above. JavaDoc comments can be documented using java commands = reference manual. Therefore, various tags can be used. It's a manual, so don't use it when writing a little explanation in the source code.
| tag | Description |
|---|---|
@param |
Explanation of parameters (arguments). |
@return |
A description of the return value. |
@author |
A description of the creator of the program. |
@throw |
A description of the exceptions that are thrown. |
Recommended Posts