回到我的 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 的情况下自动将 new @param
、@exception
和 missing参数放入我的 JavaDoc 中?@returns