Javadoc tool generation Development API documentation

===================== first a little sense of accomplishment =====================

1  PackageCom.springMybatis.dao;2 3 ImportCom.springmybatis.model.*;4 5 6 /**7 * Authorizationdao Definition Authorization Interface8  * @authorG.qu9  * @seeJava.langTen  */ One  Public Interfaceauthorizationdao{ A  -     /** - * addauthorization Add authorization the      * @paramAuthorization Authorized Objects -      * @returnBoolean true succeeds; false fails -      */ -      Public Booleanaddauthorization (Authorization Authorization); +  -     /** + * Deleteauthorization Delete authorization A      * @paramAuthorization Authorized Objects at      * @returntrue indicates successful execution; false failed -      */ -      Public Booleandeleteauthorization (Authorization Authorization); -  -     /** - * updateauthorization Update authorization in      * @paramAuthorization Authorized Objects -      * @returntrue indicates successful execution; false failed to      */ +      Public Booleanupdateauthorization (Authorization Authorization); -  the     /** * * Getauthorization Get authorization $      * @paramAuthorization Authorized ObjectsPanax Notoginseng      */ -      Public voidgetauthorization (Authorization Authorization); the  +}

Some of the generated documents:

========================= coquettish Split Line =========================

Explain the comment:

1. Single-line Comment

2, block comment

3. Tail end Comment

4. Comments at the end of the line

5. Documentation Comments (Generate development Help documentation)

[1], the use of Eclipse and Javadoc tools to generate development API documentation "Custom a folder to store, otherwise generate a lot of files; note the use of UTF-8 encoding otherwise garbled"

Before class interface Method field declaration

[2], default only for public and protect generated comments, private and default needs to be configured at the time of generation

[3], Comment command

@author Author Information

@version Version Information

@param parameter information

@return return value

@since first seen in a version

@exception exception information can exist in more than one

@deprecated do not recommend using methods that may be discarded in the future

 1/** 2 * Introduction of automotive Class 3 *<p> Automotive class specific description first line <br> 4 * Automotive class details of the second line 5 * @author man 6 * @author man2 7 * @version 1.0 8 * @see Ship 9 * @see aircraft10 */11 public class bustestjavadoc{12/**13 * is used to identify the maximum speed of the car during the year * @see #av ERAGESPEED15 */16 public int maxspeed;17/** used to identify the car driving average speed */18 public int averagespeed;19/** used to identify the car Water temperature */20 public int watertemperature;21/** used to identify the weather temperature */22 public int temperature;23 Bustestjavadoc () { 24 25}26/**27 * This method is used to measure the average speed in a period of time * @param start start time * @param end time 30 *@ return returns INT type variable * @exception java.lang.exceptionthrowwhenswitchis132 */33 public int Measureaveragespeed (int start,int end) {aspeed;36 int aspeed=12;35 return}37/**38 * This method is used to measure maximum speed of */40 publ IC int measuremaxspeed () {maxspeed return; 42}43}

Once these comments are written, the files->export->java->javadoc->. Eclipse-

Next

Next-> Select Finish;

Javadoc tool generation Development API documentation