Visual Studio+VAssistX自动添加注释,函数头注释,文件头注释

转载:http://blog.csdn.net/xzytl60937234/article/details/70455777

在VAssistX中为C++提供了比较规范注释模板,用这个注释模板为编写的C++代码添加注释是很便捷的选择,操作起来也很简单,具体方法和步骤如下:

1.增加函数头注释

这里写图片描述

之后注释模板中编辑自己需要的注释内容:

这里写图片描述

编辑好注释模板之后将输入光标定位到需要添加注释的C++函数,然后右键进行添加

这里写图片描述

右击函数名,然后依次点击“Refacto”–>“Document Method”,这个时候函数头注释就会蹦出来,不过这个注释的格式是默认的,想修改注释格式,可以通过以下方法。

点击 “VAssistX”–>“Visual VAssistX Options”然后选择Suggestions,再点击“Edit VA Snippets”。 
在打开的窗口中选择Refactor Document Method,在这就可以更改你的显示样式了。可以参照默认的注释格式来定制自己的注释:

/*!
*@brief  
*@author %USERNAME%
*@date   $YEAR$年$MONTH$月$DAY$日
*@param[out] 
*@param[in]  $MethodArg$  
*@return     $SymbolType$  
*/
 
 
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8

2.增加文件头注释

要想在文件头添加注释,需要 
把鼠标光标定位到VS编辑器的第一行,点击 “VAssistX”–>“Insert VA Snippet…”—>“File Header Detail”,即可增加文件头注释。默认的注释格式如下,可以通过点击“VAssistX”–>“Visual VAssistX Options”—>“Advanced”—>“Suggestions”—>“Edit VA Snippets”,选择你相应语言的“File Header Detail”修改

/********************************************************************
/*!
 * \file client.cpp
 *
 * \author TerryTian
 * \mail tianhaohust@gmail.com
 * \date 九月 2016
 *
 * 
 */
*********************************************************************/
  • 1
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
番茄助手的文件注释说明可以根据需要进行自定义。在PyCharm中,可以通过以下步骤进行设置: 1. 在File菜单中选择Settings。 2. 在Settings窗口中选择File and Code Templates。 3. 在Python Script选项下可以自定义生成文件时的文件注释信息。 以下是一些常用的文件注释模板示例: 1. 文件注释: /** * @file $FILE_BASE$.$FILE_EXT$ * @brief This is a brief description. * @author ${Author} * @par Copyright (c): * ***. * All Rights Reserved * @date $DATE$ * @note matters needing attention * @version 1.0 */ 2. 类注释: /** * @class <class‐name> * @brief This is a brief description. * @author ${Author} * @note matters needing attention */ 3. 函数注释: /** * @brief This is a brief description. * @param[in] inArgName input argument description. Type name: purpose (Range) * @param[out] outArgName output argument description. * @Return: $SymbolType$: description of the return value */ 4. 文件防止重复包含: #ifndef _$FILE_BASE_UPPER$_$FILE_EXT_UPPER$_ #define _$FILE_BASE_UPPER$_$FILE_EXT_UPPER$_ $selected$ #endif // _$FILE_BASE_UPPER$_$FILE_EXT_UPPER$_ 这些模板可以根据具体需求进行修改和扩展。在VS编程环境中,可以使用扩展工具VassistX的Edit VA Snippets功能来插入注释。<span class="em">1</span><span class="em">2</span><span class="em">3</span> #### 引用[.reference_title] - *1* [Pycharm如何自动生成文件注释](https://download.csdn.net/download/weixin_38747978/13706924)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v93^chatsearchT3_2"}}] [.reference_item style="max-width: 33.333333333333336%"] - *2* [visual studio中番茄助手添加注释模板](https://blog.csdn.net/sinat_36304757/article/details/124841100)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v93^chatsearchT3_2"}}] [.reference_item style="max-width: 33.333333333333336%"] - *3* [VS 番茄助手添加注释 以及使用方式](https://blog.csdn.net/o_ojjj/article/details/125205140)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v93^chatsearchT3_2"}}] [.reference_item style="max-width: 33.333333333333336%"] [ .reference_list ]

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值