Java 文档注释：javadoc命令

JavadocCmd.txt

• $ javadoc SquareNum.java
• Loading source file SquareNum.java...
• Constructing Javadoc information...
• Building tree for all the packages and classes...
• Generating SquareNum.html...
• Generating package-summary.html...
• Generating index.html...
• 1 warning

📦输出了哪些文件

• 每个类单独一个 HTML 文件；
• 另外还有包摘要、继承树、索引、
• 废弃列表、常量值表等页面。

void 方法别写 @return

• javadoc 会对不规范的地方给出警告：
• warning - @return tag cannot be used
• in method with void return type.
• 返回值类型为 void 时不要写 @return。