javadoc 标签功能

Posted 2021-01-18 飞龙dragon

CMD文档注释编译命令:

javadoc Helloword2.java

javadoc -d doc -encoding UTF-8 -charset UTF-8  -author -version *.java 文档注释编译命令

@see 引用其它文类
@link package.class#member label 和@see 差不多
@docRoot 产生到文档根目录的相对路径
@inheritDoc  从该类的最直接基类中继承文档注释
@version version-2.0  版本名
@author feilong  作者名字
@since jre1.3    指定程序最早使用的代码
@param parmeter-name description    parmeter-name方法的参数列表标识符 description是可延续数行的文本,终止于新的文档标签出现之前
@return description description用来描述返回值的含义
@throws fully-qualified-class-name description  异常
@Deprecated 指出一些旧特性被新特性取代

代码:

// object/HelloWord.java

package object;
import java.util.*;
/** The first Thinking in java example program
 * Displays a string and today‘s date
 * @see 
 * @link 
 * @docRoot 
 * @inheritDoc 
 * @version version-2.0
 * @author feilong
 * @since jre1.3
 * @throws fully-qualified-class-name description
 * @Deprecated 
 */
public class HelloWord2 {
    /** Entry point to class  application
     * @param args array of string arguments
     * @author exceptions No exception thrown 
     */
    public static void main(String[] args)
    {
        System.out.printf("%s
","hello world");
        System.out.println(new Date());
    }
}/* output:
javadoc -d doc -encoding UTF-8 -charset UTF-8  -author -version *.java 文档注释编译命令
hello it‘s
wed November 5 23:01:34 MDT 2018
*///~