有没有类似于GhostDoc的C++工具？

Question

当我使用C#进行开发时，我会大量使用GhostDoc来加速注释代码的过程。我目前正在开发一个C++项目，但是我还没有找到一个相应的工具。我知道Doxygen，但我所知道的是它用于创建代码以外的文档，而不是在代码中添加注释。是否有类似的好用工具？我希望它能在VS中运行，但我也可以接受在任何IDE中运行的工具。

(在提及之前，我不仅仅依靠GhostDoc来创建注释。我只是使用它来创建我的注释的起点。)

- epotter

---

仅供记录 - GhostDoc v4 现在也支持为 C/C++ 生成 XML 注释。 - sergeb

Answer 1

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

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

以上仅是一些关键特性的摘要 - 这个功能比较与其他产品的比较是更完整的功能列表。

- Jason Williams

Answer 2

Visual Assist 通过在输入时（或其他情况下）提供自定义脚本来帮助。

例如，您可以使用以下脚本进行注释：

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

当您开始输入“/**”时，会建议使用组合框（与 intellisense 完全相同）。选择此建议（通过 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++）系统的行为也是可定制的。

- Klaim

Answer 3

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

- Anton Gogolev