JavaDoc生成文档

JavaDoc生成文档

百度搜索：阿里巴巴开发手册，仔细看！

百度搜索：java SE 文档——API和文档，即在线API帮助文档https://docs.oracle.com/javase/8/docs/api/，挑重点的有用的学习

文档注释：加在类前面是类的注释，加在方法前面是方法的注释

package com.li.base;

/**
 * @author lalala
 * @version 1.0
 * @since 1.8
 */
public class Doc {

    String name;

    /**
     * @author liyang
     * @param name
     * @return
     * @throws Exception
     */
    public String test(String name) throws Exception{
        return name;
    }
}

1. 通过命令行生成JavaDoc文档：

1. 在类上右键-->Open in-->Explorer
2. 在地址栏输入cmd，即在此类所在文件夹打开控制台
3. DOS命令：javadoc -encoding UTF-8 -charset UTF-8 Doc.java（ -encoding UTF-8 -charset UTF-8是为了解决可能出现的中文乱码问题）
4. 文件夹会生成一堆文件，打开index.html
5. 便会看到生成的JavaDoc文档

生成的文档：

打开文件index.html后的界面

2. 通过IDEA生成JavaDoc文档：选中要生成的类-->Tools-->Generate JavaDoc...