10

当我使用 C# 进行开发时，我大量使用 GhostDoc 来加快注释我的代码的过程。我目前正在开发一个 C++ 项目，但我还没有找到等效的工具。我知道 Doxygen，但据我所知，它用于在代码之外创建文档，而不是在代码中创建注释。有没有好的等效工具？我更喜欢在 VS 中运行的一种，但我可以处理在任何 IDE 中运行的一种。

（在有人提出之前，我不仅仅依靠 GhostDoc 来创建评论。我只是用它来创建我的评论的起点。）

4

3 回答 3

8

我编写了一个插件Atomineer Pro Documentation，它与 GhostDoc 非常相似（它生成/更新文档注释以在编写文档时节省大量时间和精力），但它直接为自己解析代码，因此能够处理 C、C++、C++/CLI、C#、Java 和 Visual Basic 代码，并且不需要周围的代码在它工作之前处于编译状态。它还将自动添加/更新文档以处理更棘手的事情，例如在方法体中抛出的异常。

它在 Visual Studio 11、2010、2008 和 2005 下运行，并支持 Documentation-Xml、Doxygen、JavaDoc 和 Qt 注释格式，以及注释块的格式/样式和使用的高度可配置的自动文档规则。它还有许多其他方便的功能，例如帮助将遗留文档注释转换为上述格式，以及文档注释和普通块注释中的自动换行。

以上只是一些关键功能的摘要 -与其他产品的功能比较可作为许多其他可用功能的更完整列表。

于 2009-04-28T21:38:53.823 回答
3

Visual Assist通过提供在键入（或其他）时执行的自定义脚本来提供帮助。

例如，您可以为这样的注释编写脚本：

/************************************************************************/
/* My comment : $end$                                                                     */
/************************************************************************/

例如，当您开始输入“/**”时，会建议（通过与智能感知完全相同的组合框）。当您选择此建议时（通过 Enter/Space/Click - 可自定义），它将在您的光标所在的位置插入脚本，并将“$”字符之间的标记替换为特殊值（例如当前文件名）。此处的 $end$ 标记将使光标在脚本执行时位于此位置。这样，您可以继续流畅地打字。例如，对于前面的脚本集，准确键入：

/** this is a test comment to show you one of the many features Visual Assit!

只会给出：

/************************************************************************/
/* My comment : this is a test comment to show you one of the many features Visual Assit!                                                                     */
/************************************************************************/

它非常容易定制，并且建议（阅读：intellisense++）系统的行为是可定制的。

于 2009-02-12T19:05:30.193 回答
0

Visual Assist可能会完成这项工作，但我不确定。

于 2009-02-10T15:27:00.173 回答