JavaDoc生成自己的API文档

JavaDoc的注释参数

  • @author 作者名
  • @version 版本号
  • @since 需要的最早java版本
  • @param  函数参数
  • @ return 返回值
  • @ throws 异常抛出情况

 生成JavaDoc步骤

如下代码所示，其中，注释部分是要生成JavaDoc的部分

 1 /**
 2  * @author loubin
 3  * @version 1.0
 4  * @since 1.8
 5  */
 6 
 7 public class Main {
 8 
 9     /**
10      *
11      * @param args
12      * @return String
13      */
14     public static String main(String[] args) {
15         String a = "hello word";
16         return a;
17 
18     }
19 }

如果用IDEA生成JavaDoc文档，点击工具栏Tools下的Generate JavaDoc，选择输出路径和需要生成API文档的文件，将自动生成，生成的目录如下

 

 打开index.html，将在浏览器中打开API文档。

 

posted @ 2022-10-31 09:22  地球上最后一个直男  阅读(97)  评论(0)  编辑  收藏  举报