使用VAssistX为VS2008 c++代码添加函数头注释 .

一键生成C++函数头注释：VAssistX插件教程

最新推荐文章于 2024-11-15 16:40:45 发布

转载最新推荐文章于 2024-11-15 16:40:45 发布 · 930 阅读

杂类专栏收录该内容

3 篇文章

订阅专栏

本文介绍如何使用VAssistX插件为C++函数快速添加自定义注释，包括修改默认样式、设置显示格式及提高代码效率的方法。

在VC6.0里边，C++函数头注释是使用一个宏完成的，VS系列中C#在函数头输入三个反斜杠也会自动生成XML格式的函数头注释。

又懒得在VS2008中写类似于添加函数头的注释，只能依靠一些工具了,今天给大家介绍VAssistX。

大家可以下载VAssistX插件，安装的时候一定要把VS2008关掉。VAssistX在这就不多做介绍了，大家可以百度或者google之。

以下为大家介绍一下怎么添加函数头注释

随便打开一个C++的工程，找到一个方法，右击函数名，然后依次点击“Refacto”–>“Document Method”，这个时候函数头注释是不是已经出来了，很方便吧。

但是这个注释格式是默认的，可能不适合你的项目。可以在VAssistX的选项中更改显示样式，在VS2008中点击“VAssistX”–>”Visual VAssistX Options”然后选择Suggestions,再点击”Edit VA Snippets”

在打开的窗口中选择Refactor Document Method，在这就可以更改你的显示样式了。

[cpp] view plain copy print ?

//************************************
// 函数名称: $SymbolName$
// 函数说明：
// 作成者：Mr.M
// 作成日期：$DATE$
// 返回值: $SymbolType$
// 参数: $MethodArg$
//************************************

//************************************
// 函数名称: $SymbolName$
// 函数说明：
// 作 成 者：Mr.M
// 作成日期：$DATE$
// 返 回 值: $SymbolType$
// 参    数: $MethodArg$
//************************************

这是我设置的，大家赶快试试吧。这个插件会大大的提高你的工作效率。