【问题标题】:Auto-generate Javadoc comments in Eclipse?在 Eclipse 中自动生成 Javadoc 注释?
【发布时间】:2012-09-16 20:10:12
【问题描述】:

是否可以为 Eclipse (Indigo) 中的一个类中的每个方法自动生成 Javadoc cmets?

【问题讨论】:

  • 在 Outline 中选择方法并按 Alt-Shift-J。您可能需要编辑模板以获得所需的确切 cmets。
  • 这是 cmd+alt+J 在 Mac 上

标签: java eclipse automation


【解决方案1】:

可能有更好的方法,但是如果您在包资源管理器中展开类,选择您要记录的方法,然后右键单击并选择“源 -> 生成元素注释”,它将为所有选定的添加 cmets方法。

【讨论】:

  • @maximus:你确定选择多种方法开始,例如通过 ctrl 单击?
  • @maximus:您需要在视图大纲中选择方法,如果您在编辑器中选择它们,注释将仅适用于第一个(如果有)。
  • 此方法仅适用于未记录的方法。为了获得更好的覆盖率和准确性,请按照 Krzysztof Jabłoński 的建议使用 JAutodoc eclipse 插件:stackoverflow.com/a/12580831/904375
  • 转到窗口 > 在视图中打开 > 大纲然后选择你想要的方法,然后来源 > 生成元素注释
  • 还有ALT + SHIFT + J :)
【解决方案2】:

另一种选择可能是双击方法的名称,然后是 ALT+Shift+J 快捷键。

【讨论】:

  • 对于 MacOS,使用 CMD + Option + J
【解决方案3】:

还有用于生成 javadoc 的外部工具,例如 JAutodoc eclipse plugin。可以自定义模板以满足您的期望。

【讨论】:

    【解决方案4】:

    在 Eclipse 中,您可以创建 java doc 模板,然后只需在要记录的元素上方键入 java-dock block /**

    在生成代码的情况下,模板也会生成 java-doc。

    所有这些,甚至更多,您都可以在 Window -> Preferences, Java -> Code Style -> Code Templates -> Comments 中进行配置

    【讨论】:

    • 谢谢!顺便说一句,有没有办法一次为所有方法创建这些类型的命令?
    • @maximus,解决方案是 Jon Skeet 回答。
    猜你喜欢
    • 2016-05-24
    • 2016-05-05
    • 2010-12-19
    • 2011-02-15
    • 2011-02-01
    • 2018-06-06
    • 1970-01-01
    • 1970-01-01
    • 2012-06-23
    相关资源
    最近更新 更多