11.黑窗口、IDEA生成JavaDoc
JavaDoc:
它是一种技术,可以将一些注释信息生成一个帮助文档,就类似于Java的API
JavaAPI帮助文档:
@author 作者
@version 版本
@since 自然号 指明需要最早使用的JDK版本
@param 参数
@return 返回值
@throws 异常抛出情况
1 package com.duan.operator; 2 3 /**类注释 4 * @author duanfu 5 * @version 1.0 6 * @since 1.8 7 */ 8 public class Doc { 9 10 String name; 11 12 /**方法注释 13 * @param name 14 * @return 15 * @throws Exception 16 * @author duanfu 17 */ 18 public String test(String name) { 19 return name; 20 } 21 22 }
黑窗口命令行生成JavaDoc文档 :API接口帮助文档
![](https://img2018.cnblogs.com/i-beta/1697640/202001/1697640-20200121154746542-238324363.png)
![](https://img2018.cnblogs.com/i-beta/1697640/202001/1697640-20200121154817422-794631647.png)
使用IDEA生成JavaDoc文档:
![](https://img2018.cnblogs.com/i-beta/1697640/202001/1697640-20200121155009977-613931487.png)