javadoc 命令生成类的解释文档

首先介绍 Java 的 3 种注释：

1. // 单行注释

2. /*
    多行注释
   */ 

3. /**
    文档注释 可以借助 javadoc 的命令将文档注释(markdown)生成为html
   */

建个 CommentTest 类，路径 csu\src\CommentTest.java

package com.shuai.test;

/**
 * Created by shuai
 * on 2017/8/15.
 * @author shuai 作者
 * @since 1.0 JDK 版本
 */

public class CommentTest {

    /**
     * @param s String
     * @return String
     */
    public String test(String s) {
        return "hello";
    }

    public static void main(String[] args) {
        
    }
}

命令行执行命令

ShuaideMacBook-Pro:src shuai$ javadoc -d ../doc CommentTest.java 
正在加载源文件CommentTest.java...
正在构造 Javadoc 信息...
正在创建目标目录: "../doc/"
标准 Doclet 版本 1.8.0_131
正在构建所有程序包和类的树...
正在生成../doc/com/shuai/test/CommentTest.html...
正在生成../doc/com/shuai/test/package-frame.html...
正在生成../doc/com/shuai/test/package-summary.html...
正在生成../doc/com/shuai/test/package-tree.html...
正在生成../doc/constant-values.html...
正在构建所有程序包和类的索引...
正在生成../doc/overview-tree.html...
正在生成../doc/index-all.html...
正在生成../doc/deprecated-list.html...
正在构建所有类的索引...
正在生成../doc/allclasses-frame.html...
正在生成../doc/allclasses-noframe.html...
正在生成../doc/index.html...
正在生成../doc/help-doc.html...

之后就生成了完整的注释，路径 csu\doc