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

2022-09-03 01:21:28

回到我的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 中,而不会丢失我当前拥有的 JavaDoc?@param@exception@returns


答案 1

不确定以下内容是否是您所关注的,但是由于eclipse有自己的JavaDoc Validator,因此您可以在

Window -> Preferences -> Java -> Compiler -> JavaDoc.

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

enter image description here


答案 2

Eclipse也支持JavaDoc的“代码”完成。您不必键入孔语句。您只需键入“@p”,Ctrl + Space将为您打印其余部分。或者更好的是,只需写下参数表的名称,代码完成将添加其余部分。

它不是直接的快捷方式,但是您可以更快地使用javadoc,而不是从头开始编写所有内容。

@t(@throw)@r(@return)等也是如此。

编辑您的评论:

您可以配置 Checkstyle,以便自动检查您的类。Checkstyle 将报告您的方法何时具有未记录的参数或某些其他缺少的参数。Checkstyle还可以检查您的第一个句子是否以“.”结尾。你可以手动制定很多这样的规则。

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


推荐