有什么像GhostDoc for C ++

时间:2009-02-10 15:24:57

标签: c++ ghostdoc

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

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

3 个答案:

答案 0 :(得分:6)

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

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

以上只是一些主要功能的摘要 - 此comparison of features与其他产品一起提供了更多完整的其他功能列表。

答案 1 :(得分:3)

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 ++)系统的行为是可定制的。

答案 2 :(得分:0)

Visual Assist可能会完成这项工作,但我并不十分确定。