Java基础12：JavaDoc生成文档

文档类注释：
/**
*
*
/

加在类上就是类的注释
加在方法上就是方法的注释
常用的注释标签:

@author 作者
@version 版本
@see 参考转向
@param 参数说明
@return 返回值说明
@exception 异常说明
@since jdk版本

文档类注释的用法：
package com.wenjian.base;

/**
 * @author qwe
 * @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;
    }

}
基本学习了：

生成java Doc 的两种方法
1.编译一份文档方便阅读：
在.java文件夹中打开cmd，
    javadoc -encoding UTF-8 -charset UTF-8 Doc.java
会在文件夹中生成一系列html，文档打开index.html
2.作业：学会查找使用IDEA生产avaDoc文档！面向百度编程！：

posted @ 2020-07-12 23:27  nkndlawn  阅读(132)  评论(0)    收藏  举报