如何在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,我必须做一堆复制面食.我怎么能自动将新@param,@exception以及缺少@returns参数到我的JavaDoc不失,我目前拥有的JavaDoc的？

Answer 1

不确定以下是否适合您,但由于eclipse有自己的JavaDoc Validator,您可以配置编译警告/错误

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

随着自己的需要激活缺少javadoc标记和设置警告级别设置为"警告",编译器会尽快通知您的更改,并给你一个警告,因为你的javadoc从你的方法的签名不同.要修复它,它提供了一个quickfix(STRG + 1),你可以选择添加所有缺少的标签.此操作甚至会在正确的位置添加缺少的标记,而不会弄乱您的旧评论.