在源代码中生成 Javadoc 注释

另请参见

您可以使用编辑器提示,在源文件中为代码元素自动生成基本的 Javadoc 注释。生成的注释包括特定代码元素所需的标记。例如,如果某个方法使用参数,则会插入 @param 标记。还可以使用提示来生成 Javadoc 注释的更正内容,例如,当注释包含不正确的标记时。

将在源代码编辑器的左旁注处显示一个灯泡图标,为您提供编辑器的错误提示。可通过单击灯泡图标或按 Alt-Enter 组合键来阅读提示。并单击提示或按 Enter 键来生成提示建议的代码。

缺省情况下,Javadoc 生成提示处于禁用状态。

启用 Javadoc 注释提示:

  1. 选择“工具”>“选项”。
  2. 单击“选项”窗口顶部的“Java 代码”按钮。
  3. 单击“提示”标签。
  4. 选中 "Javadoc" 复选框。

缺省情况下,Javadoc 提示仅适用于受保护的元素和公共元素。如果要更改提示的范围,请展开 Javadoc 节点并选择一个子节点。然后根据要应用的提示范围,选择相应的单选按钮。

有关 Javadoc 标记的详细信息,请参见:

有关如何编写 Javadoc 注释的信息,请参见:

另请参见
生成 Javadoc 文档
在项目中添加 Javadoc 库

法律声明