编写文件

package lee;
/**
这是我写的类描述信息
个人网站：baidu.com
@author: 上帝
@version: 9.9
*/
public class JavaDocText{
    /**
    这是成员变量描述信息
    定义了资格字符串的名字
    */
    public String name;
    /**
    这是主方法的描述信息，
    程序的入口
    @param args[] 控制台传入的参数
    */
    public static void main(String args[]){
        System.out.println("这是一个测试java文档的类");
    }
}

生成文档

C:\Users\xxx\Desktop\java\object>javadoc JavaDocText.java -d com -encoding utf-8
正在加载源文件JavaDocText.java...
正在构造 Javadoc 信息...
标准 Doclet 版本 1.8.0_121
正在构建所有程序包和类的树...
正在生成com\lee\JavaDocText.html...
正在生成com\lee\package-frame.html...
正在生成com\lee\package-summary.html...
正在生成com\lee\package-tree.html...
正在生成com\constant-values.html...
正在构建所有程序包和类的索引...
正在生成com\overview-tree.html...
正在生成com\index-all.html...
正在生成com\deprecated-list.html...
正在构建所有类的索引...
正在生成com\allclasses-frame.html...
正在生成com\allclasses-noframe.html...
正在生成com\index.html...
正在生成com\help-doc.html...

想要提取author等需要在加-author
-d 生成到什么目录

查看文档

打开生成目录下的index.html文件

image.png