【帆吖】Java学习零基础08

JavaDoc文档

---

 https://docs.oracle.com/javase/8/docs/api/

---

@author 作者名

@version 版本号

@since 指明需要最早使用的jdk版本

当然还有一些其他注解，例如在类的方法上：

@param 参数名

@return 返回值情况

@throws 异常抛出情况

---

C:\Users\fan\Desktop\Markdown学习\javaSE\基础语法\src\operator>javadoc -encoding UTF-8 -charset UTF-8 Doc.java

---

1.   选择是整个项目还是模块还是单个文件

2.   文档输出路径

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

4.   传入JavaDoc的参数，一般这样写 -encoding UTF-8 -charset UTF-8 -windowtitle “文档HTML页面标签的标题” -link 

---

 

package test;


/**
 * @author  fan
 * @version   1.0
 * @since  1.8
 */
public class Doc {
    String name;               // 属性


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