不同的头文件注释

 

在第17讲的时候讲述了如何创建自己的模板,即把原来的模板加上头文件注释,模板的位置是你的安装目录的Common7/IDE/ItemTemplatesCache文件夹下,然后在找相应的语言不同的模板类来进行设置,比如我的安装目录是D:/VisualStudio下,我设置的是C#语言,则我应该打开的目录是D:/Visual Studio/Common7/IDE/ItemTemplatesCache/CSharp

下面我来介绍几种不同文件的头文件注释:

1、/*……*/

对于.cs文件,.js文件和.css文件等文件的头文件注释都是/*……*/,举例如下:

  

 
2、<!--……-->



像.xml文件或者.htm文件以及.Config文件(就是文件里有类似<!……>这样格式的文件

)等都是使用这种注释,比如:




 
3、<%--……--%>



像.aspx,.Master,.ashx文件或者.asax文件(文件内容中有类似<%……%>这种格式的文件

)等都使用这种注释,比如:



 

这样修改完成后,再添加文件即可自动添加头文件注释了。

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 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、付费专栏及课程。

余额充值