当我在C#正在开发,我大量使用GhostDoc加快评论我的代码的过程。我目前工作的一个C ++项目,我还没有找到一个等效的工具。我知道Doxygen的,但是从我知道它是用来代码之外创建的文档,而不是在代码中的注释。是否有良好的等价工具?我宁愿一个在VS运行,但我可以处理一个在任何IDE配合工作。

(之前有人提起这件事,我不单靠GhostDoc创建的意见。我只是用它来创建我的意见的出发点。)

有帮助吗?

解决方案

视觉辅助有助于通过提供打字时(或其他)来执行自定义脚本。

例如,可以有一个脚本用于这样的评论:

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

这将被建议(通过组合框酷似智能感知)时开始输入“/ **”,例如。 当您选择此建议(通过输入/空间/点击 - 可定制),它会在您的光标插入脚本,只需更换那些之间的“$”字符的特殊值(例如像当前的文件名)标记。 在这里,$ 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!                                                                     */
/************************************************************************/

这是很容易定制和建议的行为(读:智能感知++)。系统是可定制

其他提示

我已经写一个加载,的 Atomineer临文档 下,这非常类似于GhostDoc(它产生/更新文档注释文档时节省了大量的时间和精力),但它直接解析代码本身,因此能够处理C,C ++,C ++ / CLI,C#,Java的和Visual Basic代码,不需要周围的代码是在编译状态之前它会工作。它还会自动添加更多技巧性的东西/更新文件,如方法体内抛出的异常。

它运行的Visual Studio 11,2010年,2008年和2005年的义务,支持文档的XML,使用Doxygen,的JavaDoc和Qt评论格式,以及注释块的格式/风格和自动文档规则中使用的是高度可配置。它有许多的其他方便的功能,如辅助的遗留DOC-评论转换到上述的格式,和自动换在DOC-评价和正常块注释

上面的仅仅是一个一些主要特点总结 - 此的特征比较与其他的产品用作可用的许多其他功能更完整的列表。

视觉辅助可能做的工作,虽然我没有绝对的把握。

许可以下: CC-BY-SA归因
不隶属于 StackOverflow
scroll top