Java 文档注释

Java 文档注释

狂神说Java BV12J41137hu

将注释信息生成API文档

说明注释允许你在程序中嵌入关于程序的信息。你可以使用 javadoc 工具软件来生成信息，并输出到HTML文件中。

说明注释，使你更加方便的记录你的程序信息。

官方API文档

Oracle Java SE API & 文档

Java™ Platform, Standard Edition 8 API Specification

javadoc 标签

javadoc 工具软件识别以下标签：

标签	描述	示例
@author	标识一个类的作者	@author description
@deprecated	指名一个过期的类或成员	@deprecated description
	指明当前文档根目录的路径	Directory Path
@exception	标志一个类抛出的异常	@exception exception-name explanation
	从直接父类继承的注释	Inherits a comment from the immediate surperclass.
	插入一个到另一个主题的链接
	插入一个到另一个主题的链接，但是该链接显示纯文本字体	Inserts an in-line link to another topic.
@param	说明一个方法的参数	@param parameter-name explanation
@return	说明返回值类型	@return explanation
@see	指定一个到另一个主题的链接	@see anchor
@serial	说明一个序列化属性	@serial description
@serialData	说明通过writeObject( ) 和 writeExternal( )方法写的数据	@serialData description
@serialField	说明一个ObjectStreamField组件	@serialField name type description
@since	标记当引入一个特定的变化时	@since release
@throws	和 @exception标签一样.	The @throws tag has the same meaning as the @exception tag.
	显示常量的值，该常量必须是static属性。	Displays the value of a constant, which must be a static field.
@version	指定类的版本	@version info

实操

java源码： JavaDoc.java

/**
 * @author jentreywang
 * @version 1.0
 * @since 1.8
 */
public class JavaDoc {
    String name;

    /**
     *
     * @param name
     * @return
     */
    public String test(String name){
        return name;
    }

    /**
     *
     * @param name
     * @return
     * @throws Exception
     */
    public String test2(String name) throws Exception{
        return name;
    }
}

在命令行中使用命令

当源码中出现中文时，使用参数 -encoding UTF-8 -charset UTF-8

javadoc -encoding UTF-8 -charset UTF-8 JavaDoc.java

这个API文档的生成方法非常酷炫！

IDEA生成JavaDoc

选中当前类，菜单栏 Tools -> Generate JavaDoc...