如何在Eclipse中智能地修复文档？

Question

回到我的C＃日，我喜欢使用名为“GhostDoc”的Visual Studio扩展。现在我已经被用作Java开发人员，我正在使用Eclipse。我可以在没有推断文档的情况下生活，但我想做的是智能地“修复”我的文档。例如，假设我有以下方法：

/**
 * Gets a collection of {@link Foo} objects
 * @param bar The bar level
 * @param baz The bazziness
 */
public Collection<Foo> getFoos(int bar, int baz)
{
    // Do something cool
}

稍后在开发中我意识到允许我的方法的使用者传入qux值会很有用。不仅如此，将它作为第一个参数最有意义。此外，我将使用该方法抛出超级有用的FooBarException。所以现在我的方法看起来像这样：

/**
 * Gets a collection of {@link Foo} objects
 * @param bar The bar level
 * @param baz The bazziness
 */
public Collection<Foo> getFoos(String qux, int bar, int baz) throws FooBarException
{
    // Do something cool
}

作为一名优秀的开发人员，我希望我的更改能够反映在我的JavaDoc中。在GhostDoc中，我可以点击我的文档快捷键，它会添加新的东西，而不会打扰旧的东西。在Eclipse中，它呈现了一整套新的JavaDoc，我必须做一堆复制面食。如何在不丢失我当前拥有的JavaDoc的情况下自动将新的@param，@exception和缺少的@returns参数添加到我的JavaDoc中？

Answer 1

不确定以下是否适合您，但由于eclipse有自己的JavaDoc Validator，您可以在

下配置编译警告/错误

窗口 - ＆gt;偏好 - ＆gt; Java - ＆gt;编译器 - ＆gt; JavaDoc的。

根据您自己的需要激活缺少的javadoc标记并将警告级别设置为“warning”，编译器会在您的javadoc与您的方法签名不同时立即注意到您的更改并发出警告。要修复它，它提供了一个quickfix（STRG + 1），你可以选择添加所有缺少的标签。此操作即使在正确的位置也会添加缺少的标记，而不会弄乱您的旧评论。

Answer 2

Eclipse支持“代码” - JavaDoc的完成。您不必键入hole语句。您只需键入“@p”，CTRL + Space将为您打印其余部分。或者甚至更好，只需写下parmeter的名称，代码完成将添加其余部分。

它不是直接的快捷方式，但你可以更快地增强javadoc，而不是从头开始编写所有内容。

@t（@throw）@r（@return）等等。

编辑您的评论：

您可以配置Checkstyle，以自动检查您的课程。当您的方法具有未记录的参数或其他一些缺少的参数时，Checkstyle将报告。 Checkstyle还可以检查你的第一句话是否以“。”结尾。或不。你可以手工制作很多这样的规则。

Checkstyle将在您的java代码编辑器和问题视图中添加问题标记。因此，您可以轻松找到带有javadoc问题的代码行。

Answer 3

http://jautodoc.sourceforge.net/ 与Luna合作也很好 请检查市场

Answer 4

在典型的评论位置上方输入/ **（与GhostDoc相同的位置）将自动完成评论的模板。

如果使用重命名功能（Shift + Alt + R）更改变量的名称，那么Eclipse也将更改所有正确位置的名称，假设代码已编译。

这包括并评论您所做的链接

/**
 *
 * My funky method
 *
 * @param myThing
 *         myThing is of type {@link MyThingClass}
 */
 public void myMethod(MyThingClass myThing) {}

使用Eclipse的重命名功能重命名myThing或MyThingClass也会更新这些引用。

同样，使用“更改方法签名”功能也会更新您的评论。

基本上，如果您正在重构，请使用重构菜单（Shift + Alt + T）。

Answer 5

Checkstyle已被提及。我试了一下，但它似乎减慢了我的Eclipse（E4 juno虽然因为有一些不好的减速而闻名）。

Google CodePro做得更好，所以我现在正在使用它。

当然，您可以启用JavaDoc警告。