在源代码中输入 Javadoc 注释
另请参见
可以使用“自动注释工具”,为所有尚未说明的代码元素自动输入 Javadoc 注释。“自动注释工具”可以确定是否:
- 所有应该说明的 Java 元素都有 Javadoc 注释。
- 现有注释与它们所属的元素对应。例如,方法中的每个参数都必须有一个 @param 标记,此方法抛出的每个异常都必须有 @throws 标记等等。
检查 Javadoc 注释的源代码:
- 在“项目”窗口或“文件”窗口中右键单击要检查的文件,然后选择“工具”>“自动注释”。
- 从左窗格的列表中选择方法,您要为其更正标记错误或生成缺少的标记。可以使用过滤器工具栏按钮控制要显示的类和成员。
图标表示有效的 Javadoc 注释,
表示不完整或不正确的注释,
表示无注释。
- 单击“自动校正”。
- 如果需要注释,IDE 会生成缺少的标记并在“自动注释”对话框的“标记”面板以及源文件中该方法的前一行中显示它们。
- 如果注释是不完整的或不正确的,则 IDE 会在“自动注释”对话框的“详细信息”面板中显示如何完成注释的信息。
- 进行任何其他所需的编辑。如果注释正确无误,则“详细信息”窗格会显示“Javadoc 注释正确”。
- 完成编辑后,在“编辑器”窗口中关闭“自动注释工具”标签退出该工具。
有关 Javadoc 标记的详细信息,请参见:
有关如何编写 Javadoc 注释的信息,请参见:
- 另请参见
- 生成 Javadoc 文档
- 在项目中添加 Javadoc 库
法律声明