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

程序员成长之旅 · 程序员成长之旅/Java学习/笔记 · 360 字

//源码
/**
这是一条测试信息
注释信息
@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 -d doc Test.java

(-d 是指定输出目录)

效果

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

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

@version 标明该类模块的版本

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

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

@return 对方法返回值的说明

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

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

附件

Test.java