设置VS助手函数说明注释

平时写程序的时候为了规范通常会需要对函数或者文件添加一些注释说明比如:

  1. /******************************************************************************* 
  2. 名称:void Function() 
  3. 功能:函数功能描述
  4. 参数:无 
  5. 时间: 
  6. 版本:1.0 
  7. 注意:
  8. *******************************************************************************/  

通过VA  可以设置很方便的自动完成这个功能,而且还支持自定义,因此可以根据自己的习惯配置适合自己的。设置方法如下:

打开Visual Assist X Options-Advanced-Suggestions选择Edit VA Snippets会弹出一个窗口,窗口分为左右两部分,左侧是shortcut,就是在输入程序的时候开始提示的那个字符,可以自己添加也可以自己修改,找到/**这个选项,然后编辑右侧,这样在输入程序的时候输入/**就会自动提示右侧编辑的内容,右侧输入

/************************************************************************/
/* 开发者: XXX                  */
/* 功 能: $end$ */
/* 时 间: $MONTH$/$DAY$/$YEAR$ $HOUR$:$MINUTE$ */
/* 备 注: */
/* 其 他: */
/************************************************************************/


里面加了一些参数$end$表示插入文本后结束的地方,也就是在输入/*-就会自动提示这段话,enter插入后光标会停到这个地方.
  • 1
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
番茄助手的头文件注释说明可以根据需要进行自定义。在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 ]
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值