Javadoc Syntax We can use Javadoc to organize program documents in developing Java programs. When the program is written, the JavaDoc tool with Java can generate a specification API description manual. Below is some of my own syntax: writing Format: / ** <- Here you must use two asterists, otherwise it will be considered to be a normal annotation * ............... Javadoc only Processing an comment documentation for class members of public, protected. Of course, you can also use the -Private parameter forced to process, we can embed the HTML tag in the comment to enrich the display of the last document, because the finally generated documentation of Javadoc is html. / *** Some parameters list
** @see Class name * @see full class name * @see full class name # Method ** @Param parameter name description * @Return explanation * @Exception full class name description * @ deprecated * * @version version information * @author author * / Description: @see: This is an entry for the XX in the document. In fact, it is hyperlink. In general, the document has three types: class annotation, variable annotation, method comment, this three-mid type annotation can include @see parameters In addition, other parameters contained are different .1. Class annotation class comment is written in front of the class, used to explain some of the cases, can include @ version, @ Author parameters, but Javadoc is not processed by default, That is to say, in order to use this information, in order to use this information, we can join the parameters -Version and -author to force the output to the last document. 2. Variable Note Variable Note Write front of the variable, only @see parameters 3. Method Note Method Note You can include @Param: The parameter name is an identifier within the parameter list, which is some text of explanation, can be multi-row. @ Return: return value, you can multi-line @Exception: Complete class Name should be clearly specified by a violation class, which is defined in some places. The description will explain why this special type of violation will appear in the method call. Description You can @Deprecated: State out that some old function has been replaced by improved new features. The role of this tag is that users do not have to use a specific function, because this function may be abandoned when the future is revised. If a method is marked as @DepRecated, a warning for the compiler will be received when using this method.
