17

回到我的 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

4

5 回答 5

18

不知道下面是不是你说的，但是由于eclipse有自己的JavaDoc Validator，你可以在下配置compile Warnings/Errors

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

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

在此处输入图像描述

于 2012-10-17T16:19:08.507 回答
2

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

它不是直接的捷径，但您可以更快地改进 javadoc，而不是从头开始编写所有内容。

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

编辑您的评论：

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

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

于 2012-10-17T15:56:06.137 回答
2

http://jautodoc.sourceforge.net/ 也适用于 Luna，请查看市场在此处输入图像描述

于 2015-07-02T16:23:35.747 回答
1

在典型的评论位置（与 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)。

于 2012-10-17T16:08:38.793 回答
1

Checkstyle已经提到过。我试过了，但它似乎让我的 Eclipse 变慢了很多（尽管 E4 juno，它以有一些糟糕的减速而闻名）。

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

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

于 2013-01-01T18:01:12.610 回答