JavaDoc

• JavaDoc 是一种技术，可以将注释信息生成一个帮助文档，类似于Java的API

javadoc命令式用来生成自己的API文档

• 参数信息
  • @author 作者名
  • @version 版本号
  • @since 指明需要最早使用的jdk版本
  • @param 参数名
  • @return 返回值情况
  • @throws 异常抛出情况

package com.baidu.www;

/**放在类上面就是类注释
 * @author Fat_peach
 * @version 1.0
 * @since 1.8
 */

public class Doc {
    String name;

    /**
     *放在方法上面就是方法注释
     * 在方法上用文档注释（/** + 回车）会自动生成一些参数
     * @author Fat_peach
     * @param name
     * @return
     * @throws Exception
     */
    public String test(String name)throws Exception
    {

        return name;
    }
}

• 生成文档
  1. mac电脑 当前类的地址在右击 选择 Open in 后 选择 终端 ，接着输入：（第三行）
  2. Windows 也是选中当前类的地址在右击 选择 文件夹里打开，导航栏 空格 前面加cmd（打开命令提示符）然后输入：（下面一行）
  3. javadoc -encoding UTF-8 -charset UTF-8 Doc.java
  4. mac电脑 当前类的地址在右击 选择 Open in 后 选择 Finder 打开： index.html
  5. Windows 就是选中当前类的地址在右击 选择 文件夹里打开 找到并双击： index.htm