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

本文介绍如何利用VAssistX插件为Visual Studio 2008中的C++函数自动生成注释头,提高开发效率。通过简单的步骤,可以定制注释模板并应用到函数上。

本文出处:http://mr-m.me/vassistx_vs2008_cpp.html

 

在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,在这就可以更改你的显示样式了。
1
2
3
4
5
6
7
8
//************************************
// 函数名称: $SymbolName$
// 函数说明:
// 作 成 者:Mr.M
// 作成日期:$DATE$
// 返 回 值: $SymbolType$
// 参    数: $MethodArg$
//************************************
这是我设置的,大家赶快试试吧。这个插件会大大的提高你的工作效率。

<?xml version="1.0" encoding = "utf-8"?> <CodeSnippets xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet"> <CodeSnippet Format ="1.0.0"> <Header> <Title>func</Title> <Shortcut>func<Shortcut> <Description>成员函数代码注释</Description> <Author>YunYunDu</Author> <SnippetTypes> <SnippetType>Expansion</SnippetType> </SnippetTypes> </Header> <Snippet> <Declarations> <Literal> <ID>todo</ID> <Default>-</Default> <ToolTip>注释说明</ToolTip> </Literal> <Literal> <ID>details</ID> <Default>initialized</Default> <ToolTip>注释说明</ToolTip> </Literal> <Literal> <ID>param1</ID> <Default>nothing</Default> <ToolTip>param</ToolTip> </Literal> <Literal> <ID>note</ID> <Default>initialized</Default> <ToolTip>注释说明</ToolTip> </Literal> <Literal> <ID>return</ID> <Default>void</Default> <ToolTip>return</ToolTip> </Literal> <Literal> <ID>type</ID> <Default>size_t</Default> <ToolTip>控制变量类型</ToolTip> </Literal> <Literal> <ID>func_name</ID> <Default>func_name</Default> <ToolTip>函数名</ToolTip> </Literal> <Literal> <ID>return_value</ID> <Default>0</Default> <ToolTip>返回值</ToolTip> </Literal> </Declarations> <Code Language="cpp"> <![CDATA[/** * @brief $todo$ * @param $param1$ * @return $return$ */]]> </Code> </Snippet> </CodeSnippet> </CodeSnippets> 代码注释自动生成vs snippets文件,想根据c++函数有几个变量,自动生成如下的函数注释 /** * @brief function xxx * @details note xxx * @param[in/out] *data data to be returned * @param[in/out] len length of data * @param[in/out] report_fail_try_type register type \n * @return resluts */ int registerAll(vector<int> data, size_t len, double res);
最新发布
07-28
评论 5
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值