有什么像GhostDoc的C ++ [英] Is there anything like GhostDoc for C++

问题描述

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

When I'm developing in C#, I heavily use GhostDoc to speed up the process of commenting my code. I'm currently working on a C++ project and I haven't found an equivalent tool. I know about Doxygen, but from what I know it is used to create documentation outside the code, not comments in the code. Are there any good equivalent tools? I would prefer one that runs in VS, but I could handle one that works in any IDE.

（在有人提出之前，我不仅仅依赖于GhostDoc ）

(Before someone brings it up, I don't rely solely on GhostDoc to create comments. I just use it to create the starting point for my comments.)

推荐答案

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

Visual Assist helps by providing custom scripts executed while typing (or on other).

例如，您可以有一个脚本用于如下注释：

For example, you can have a script for comments like this :

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

当您开始输入时，系统会建议（通过类似intellisense的组合框） /** 例如。
当您选择此建议（通过Enter / Space / Click - 可自定义），它将插入您的光标所在的脚本，并只是替换在'$'字符之间的特殊值（如当前文件名例）。
这里$ end $ marker将在执行脚本时将光标置于此位置。这样，您可以继续顺利地输入。例如，使用上一个脚本集，正确输入：

That would be suggested (via a combo-box exactly like intellisense) when you start typing "/**" for example. When you select this suggestion (via Enter/Space/Click - customizable), it will insert the script where your cursor is and just replace markers that are between '$' characters by special values (like the current file name for example). Here the $end$ marker will make the cursor be at this position when the script is executed. This way, you continue typing smoothly. For example with the previous script set, typing exactly :

/** 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 ++）系统的行为是可自定义的。

It's really easy to customize and the behavior of the suggestion (read : intellisense++) system is customizable.

这篇关于有什么像GhostDoc的C ++的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！