Java文档注释用法+Javadoc的使用

文档注释

文档注释负责描述类、接口、方法、构造器、成员字段。可以被JDK提供的工具 javadoc 所解析，自动生成一套以网页文件形式体现的该程序说明文档的注释。

注意：文档注释必须写在类、接口、方法、构造器、成员字段前面，写在其他位置无效。

---

格式：

/**
* 对于类、接口和方法的描述
*  @ 标签
*  @ 标签
* 
*/

---

对于类、接口和方法的描述部分：
不仅可以用文字还可以使用html标签。如：<p>xxxxx</p>

标记部分：
格式如： @param parameter-name explanation

常用的标签如下：

标签	描述	示例
@author	标识一个类的作者	@author description
@deprecated	指名一个过期的类或成员	@deprecated description
{@docRoot}	指明当前文档根目录的路径	Directory Path
@exception	标志一个类抛出的异常	@exception exception-name explanation
{@link}	插入一个到另一个主题的链接	{@link name text}
@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
{@value}	显示常量的值，该常量必须是static属性。	Displays the value of a constant, which must be a static field.
@version	指定类的版本	@version info

---

使用javadoc生成文档:
cmd命令： javadoc 文件名.java

生成的网页中 index.html 就是文档的首页。

实例演示：

代码示例：

/**
 * 一个示例类
 * 测试实现数字运算
 * @author AEven
 * @version 1.10
 * */

public class Demo01 {
    /**
     * 求取两数之和
     * @param a 用来表示一个加数。
     * @param b 用来表示一个加数。
     * @return 返回两数之和。
     * */
    public int add(int a,int b) {
        return a+b;
    }
    /**
     * 求取两数之差
     * @param a 用来表示减数。
     * @param b 用来表示被减数。
     * @return 返回两数之差。
     * */
    public int sub(int a,int b) {
        return a-b;
    }
    /**
     * 求取两数最大值
     * @param a 用来表示一个要对比的数
     * @param b 用来表示一个要对比的数。
     * @return 返回两数最大值。
     * */
    public int max(int a,int b) {
        if(a>b) {
            return a;
        }
        return b;
    }

}

---

在命令提示符下运行javadoc命令

---

在当前目录下进入index.html

以上为java文档注释的应用及javadoc的简单用法。