GhostDoc 相当于 Eclipse(Java)

发布于 2024-07-27 05:24:52 字数 169 浏览 6 评论 0原文

我非常喜欢 GhostDoc 在 Visual Studio 中自动生成注释,所以我正在寻找一个与我在 Eclipse 中的 Java 代码完成相同工作的插件。 有什么建议吗?

I'm a big fan of GhostDoc's automatic comment generation in Visual Studio so am looking for an plugin that does the same job with my Java code in Eclipse. Any recommendations?

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(5

缱倦旧时光 2024-08-03 05:24:52

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

JAutodoc 是一个 Eclipse 插件
自动添加Javadoc和文件
源代码的标头。 它
可选择生成初始评论
使用 Velocity 从元素名称
Javadoc 和文件的模板
标头。

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

You can check JAutodoc (http://jautodoc.sourceforge.net/)
From the author:

JAutodoc is an Eclipse Plugin for
automatically adding Javadoc and file
headers to your source code. It
optionally generates initial comments
from element name by using Velocity
templates for Javadoc and file
headers.

This one is the one I've found closest to GhostDoc.

源来凯始玺欢你 2024-08-03 05:24:52

它基本上相当于 Javadoc,可以使用快捷方式在 Eclipse 中生成:

ALT+Shift+J

(当您在您希望为其添加 javadoc 的 Java 函数)

从那里,如果您确实想要 XML 格式,您可以尝试 使用 JELDoclet

It is basically the equivalent of Javadoc, which can be generating in eclipse with the shortcut:

ALT+Shift+J

(when you are within the Java function you wish to add javadoc for)

From there, if you really want XML format, you can try and use a JELDoclet

时光病人 2024-08-03 05:24:52

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

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

GhostDoc has a nice extra feature that infers a description of what the method does by parsing the method name and providing this as skeletal documentation. For example, using GhostDoc on a method named GetDocumentName() might return the phrase "Gets the document name". While this is hardly more information than provided by the method name, it adds method documentation where previously none existed. Some might argue that this is barely useful. I argue to the contrary because it supports generating documentation from the source code (e.g., for tools like NDoc or SandCastle).

In my opinion the greatest benefit of GhostDoc over eclipse's "Generate Element Comment" is that it encourages programmers to begin adding documentation comments by adding an extremely fast and reliable way create this. The programmer can accept the inferred text, (suitable in 50 - 80% of cases), or expand on this for more complex methods. For the junior programmer who is not as familiar with how documentation comments are used, this can quickly shorten the learning curve and encourage good programming practices.

看轻我的陪伴 2024-08-03 05:24:52

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 那么神奇。

Javadoc is not like GhostDoc my friend. Javadoc only creates the structure so one can write the documentation from scratch. GhostDoc actually fills up the information according to the Method/Property name.

Example:

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

JAutoDoc is the closest I've found so far but it's not as magical as GhostDoc.

空气里的味道 2024-08-03 05:24:52

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

Never used GhostDoc, so not sure what extra functionality it gives, but if it's about generating type and method comments based on the name, parameters, return type etc. then eclipse has it built in, so no extensions needed.

~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文