GhostDoc 等效于 Eclipse(Java)答案

【问题标题】：GhostDoc Equivalent for Eclipse(Java)GhostDoc 等效于 Eclipse(Java)
【发布时间】：2010-11-10 22:53:31
【问题描述】：

我是 GhostDoc 在 Visual Studio 中自动生成注释的忠实粉丝，所以我正在寻找一个插件，它可以在 Eclipse 中对我的 Java 代码执行相同的工作。有什么建议吗？

【问题讨论】：

标签： eclipse comments javadoc ghostdoc

【解决方案1】：

您可以查看 JAutodoc (http://jautodoc.sourceforge.net/)
来自作者：

JAutodoc 是一个 Eclipse 插件，用于自动添加 Javadoc 和文件标头到您的源代码。它可选地生成初始 cmets 使用 Velocity 从元素名称 Javadoc 和文件的模板标题。

这是我发现的最接近 GhostDoc 的一个。

【讨论】：

【解决方案2】：

它基本上相当于Javadoc，可以在eclipse中使用快捷方式生成：

ALT+Shift+J

（当您在希望为其添加 javadoc 的 Java 函数中时）

从那里开始，如果你真的想要XML格式，你可以试试use a JELDoclet

【讨论】：

值得指出的是，您可以通过 window->Preferences->Java->Code Style->Code Templates 调整生成的 javadoc
Eclipse 的内置 Javadoc 生成器与 GhostDoc 提供的功能相去甚远。请参阅克里卡罗尔的回答。

【解决方案3】：

GhostDoc 有一个很好的额外功能，它通过解析方法名称并将其作为骨架文档提供来推断方法所做的描述。例如，在名为 GetDocumentName() 的方法上使用 GhostDoc 可能会返回短语“获取文档名称”。虽然这几乎没有比方法名称提供的更多信息，但它添加了以前不存在的方法文档。有些人可能会争辩说这几乎没有用。我反对，因为它支持从源代码生成文档（例如，用于 NDoc 或 SandCastle 等工具）。

在我看来，GhostDoc 相对于 eclipse 的“生成元素注释”的最大好处是，它鼓励程序员通过添加一种极其快速和可靠的方式来开始添加文档 cmets。程序员可以接受推断的文本（适用于 50 - 80% 的情况），或者在此基础上扩展更复杂的方法。对于不熟悉文档 cmets 使用方式的初级程序员来说，这可以快速缩短学习曲线并鼓励良好的编程实践。

【讨论】：

【解决方案4】：

Javadoc 不像我的朋友 GhostDoc。 Javadoc 仅创建结构，因此可以从头开始编写文档。 GhostDoc 实际上是根据 Method/Property 名称来填充信息的。

例子：

/// <summary>
/// Gets the user from id.
/// </summary>
/// <param name="id">The id.</param>
/// <returns></returns>
private string GetUserFromId(string id);

JAutoDoc 是迄今为止我发现的最接近的，但它不像 GhostDoc 那样神奇。

【讨论】：

【解决方案5】：

从未使用过 GhostDoc，因此不确定它提供了哪些额外功能，但如果它是关于基于名称、参数、返回类型等生成类型和方法 cmets，那么 eclipse 已经内置了它，因此不需要扩展。

【讨论】：