在Eclipse中自动生成所有Javadoc注释的任何方法？

Question

我知道你可以按shift + alt + j为当前代码块插入一个合适的评论模板，但有没有办法让eclipse发疯并做一个像这样的整个项目？

Answer 1

对于整个项目，可能不是，但至少可以：

• 转到Package Explorer View
• 展开您要生成评论的课程（打开每个方法）
• 从该Package Explorer树中选择所有已打开的元素
• alt + shift + J 和voilà：在课堂上生成的评论和每个方法

对所有项目不切实际的唯一原因是：

• 您需要打开要在
上生成评论的每个班级
• 一旦评论了第一组方法，如果您编写了新方法，仍需要重复该过程。

---

话虽如此，2010年3月30日文章“ The Problem of Incomplete Javadocs ”中描述了另一种方法，主张 extended Javadoc view 。

  

扩展的Javadoc View本质上是单个代码元素（如类，方法，字段或参数）的不同信息源的聚合器。它被设计为现有Eclipse Javadoc的替代品。

  

有趣的部分来自视图中的其他选项卡：子类化指令和子类化模式。
  这些选项卡包含有关开发人员通常如何扩展所选代码元素的挖掘信息。

• 子类标签：

  

子类化指令是示例代码中常用观察的概括，例如“向导的子类总是覆盖其方法addPages()”或“Reimplementors Dialog.createContents()可以调用其超级实现”。

• 子类化模式选项卡

  

子类化模式尝试将观察到的基类扩展分组为典型的扩展模式，即，它们通过相似性对子类进行聚类以查找数据中的模式。

Answer 2

我也在寻找一个用于eclipse的自动javadoc工具，并找到了一个名为JAutodoc的工具。

此工具可以很好地生成注释，并且在某些地方只需手动进行微小更改（如果需要）。在我看来，这个工具可以节省大约75％的写评论时间。

您可以访问here以获取有关下载和集成eclipse的详细说明。

Answer 3

还有这个插件，我还没试过，但看起来很有希望：JAutoDoc

Answer 4

添加菜单图像，因为有人要它。 @Maude这是在Eclipse IDE 2020-09（4.17）上。

注意：有些用户会更改快捷方式热键以适合其工作流程，因此我们绝不能解雇某人并直接告诉他们使用快捷方式，或者弄清楚为什么快捷方式无法在其末端起作用。

上下文菜单本身是上下文相关的，因此它实际上取决于您右键单击的位置。