java - 如何在 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 值会很有用。不仅如此，将它作为第一个参数也是最有意义的。此外，我将让该方法抛出我 super 有用的 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
}

作为一名优秀的开发人员，我希望我的更改反射(reflect)在我的 JavaDoc 中。在 GhostDoc 中，我可以点击我的文档快捷键，它会在不影响旧内容的情况下添加新内容。在 Eclipse 中，它呈现了一套全新的 JavaDoc，我必须做一堆复制粘贴。如何自动将新的 @param、@exception 和丢失的 @returns 参数放入我的 JavaDoc 而不会丢失我创建的 JavaDoc目前有？

Answer 1

不确定下面是不是你说的，但是因为eclipse有自己的JavaDoc Validator，你可以在下面配置compile Warnings/Errors

窗口 -> 首选项 -> Java -> 编译器 -> JavaDoc。

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