📦 归档笔记 — 原创建于 WizNote,仅作归档展示;观点以当年为准,非最新。

Javadoc命令-输出程序注释信息页

创建时间2018-08-17最后修改2018-10-17原位置/程序员成长之旅/Java学习/笔记/字数360图片/附件4
目录:程序员成长之旅/Java学习/笔记
//源码
/**
这是一条测试信息
注释信息
@author 标明开发该类模块的作者
@version 标明该类模块的版本
@see 参考转向,也就是相关主题
@param 对方法中某参数的说明
@return 对方法返回值的说明
@exception 对方法可能抛出的异常进行说明
*/
public class HelloWorld{
    public static void main(String[] args) {
  //System.out.println("Java");
  System.out.println("imooc");
  /*System.out.println("Oracle");
  System.out.println("MySQL");*/
 }
}
🖼 图片占位(归档模式)图片见原始导出:Javadoc%E5%91%BD%E4%BB%A4-%E8%BE%93%E5%87%BA%E7%A8%8B%E5%BA%8F%E6%B3%A8%E9%87%8A%E4%BF%A1%E6%81%AF%E9%A1%B5.assets/66696828.png

命令 javadoc -d doc Test.java

(-d 是指定输出目录)

效果

🖼 图片占位(归档模式)图片见原始导出:Javadoc%E5%91%BD%E4%BB%A4-%E8%BE%93%E5%87%BA%E7%A8%8B%E5%BA%8F%E6%B3%A8%E9%87%8A%E4%BF%A1%E6%81%AF%E9%A1%B5.assets/66763906.png

PS:使用文档注释时还可以使用 javadoc 标记,生成更详细的文档信息:

@author 标明开发该类模块的作者

@version 标明该类模块的版本

@see 参考转向,也就是相关主题

@param 对方法中某参数的说明

@return 对方法返回值的说明

@exception 对方法可能抛出的异常进行说明

来源: https://www.imooc.com/code/1274

附件