JavaDoc

• JavaDoc是一种将注释生成HTML文档的技术，生成的HTML文档类似于Java的API,易读且清晰明了。

参数信息

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

package base;
/**
* 类的注释
* @author TTjango
* @version 1.0
* @since 1.8
*/
public class Doc {
    
    String name;

    /**
     * 方法的注释
     * @param name
     * @return
     * @throws Exception
     */
    public String test(String name) throws Exception{
        return name;
    }
}

如何生成Javadoc文档？

1.使用命令行生成Javadoc文档

在命令行中输入：javadoc -encoding utf-8 -charset utf-8 目标文件名.java

2.使用IEDA生成Javadoc文档

• 

• 

• 

  Locale: 选择地区，这个决定了文档的语言，中文就是zh_CN

  Other command line arguments:一般这样写 -encoding UTF-8 -charset UTF-8

• 生成后的javadoc文档

  

JavaDoc

原文：https://www.cnblogs.com/TTjango/p/14902661.html