javadoc

 

JavaDos生成文档

jdk帮助文档

• java命令是自己生成API文档的

• 参数信息

  1. @author 作者名

  2. @version 版本号

  3. @since 指明需要最早使用的JDK版本

  4. @param 参数名

  5. @return 返回值情况

  6. @throws 异常抛出情况

/**  （加在类上面就是类的注释）
*@author 作者名
*@version 版本号
*@since JDK版本
*/
public class Doc{
     String name
/**   （加在方法上面就是方法的注释）
*@param name  参数 (自动生成)
*@return 返回值情况
*/
​
public String test(Sting name){
    return name
}
}

在命令行里执行操作如下

• 右键单击idea里的java文件

• 点击下图选项

• 进入文档所属的文件夹，在路径前输入 cmd+空格+回车进入命令

• 命令行里输入 javadoc -encoding UTF-8 -charset UTF-8 Doc.java +回车

•   

• 生成许多东西，点击index.html

  

家庭作业：学会查找使用IDEA生产javadoc文档！

面向百度编程