[C++]VAssistX文件头添加注释功能设置

本文介绍如何在Visual Studio 2010中使用VAssistX插件快速设置统一的手写注释模板,提高编程效率。

问题情况:每次手写注释太慢,而且不统一。
问题原因:C++可以利用宏写注释,也可以使用VAssistX提供的方法。
问题处理:
1.安装VAssistX在VS2010上
2.VS2010菜单->VAssistX->Tools->Edit VA Snippet...
3.VA Snippet Editor窗口里找到->File Header Detail
4.把内容修改为下面的样式

 

1 /*******************************************************
2 *@brief  
3 *@author %USERNAME%
4 *@date   $YEAR$年$MONTH$月$DAY$日 $HOUR$:$MINUTE$
5 *@filebase: $FILE_BASE$
6 *@fileext: $FILE_EXT$
7 ********************************************************/

 

5.Shortcut->Filehead->保存。
6.使光标处于文件头最上方,写入Filehead,这时就会出现一个提示。

<?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
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值