【不费脑筋系列】为程序添加注释模板/版权注释/自定义头部注释等

简介: 大佬们如果经常遇到要写注释,但是手写又那么费时间,并且存在有格式标准化的情况下,可以试试使用注释模板进行配置。教程如下:

 

大佬们如果经常遇到要写注释,但是手写又那么费时间,并且存在有格式标准化的情况下,可以试试使用注释模板进行配置。教程如下:

 

1、找到对应的VS所安装的路径下。例如我的VS2022版本安装路径,如下所示,然后找到对应的版本文件夹,例如我的是企业版,对应的是 Enterprise,最后面几个路径基本各个版本都一致,在Common7/IED/ItemTemplates文件夹下。

 1995789-20211114184740792-1124477664.png

 

2、里面是各个代码的模板配置,可以对代码模板进行一些修改,这样咱们在自动生成代码的时候,就可以额外带有我们配置的其他功能了,例如代码文件头部的版权注释、或者标准注释等,或者其他玩法。以下先测试添加一个类文件的效果,在CSharp语言下的Code文件夹下,2052文件夹代表是中文版,1033是英文版,大佬们可以自行选择对应版本。选择里面的Class.cs文件打开,进行修改。

1995789-20211114184753533-1460205911.png

 

3、我此处使用VS CODE打开进行修改,大佬们还可以选择notepad++或者任意可以编辑的工具,都可以,不局限一样。我对原有的文件,加了两处注释,如图所示。

1995789-20211114184802555-167868443.png

 

4、添加完毕,保存以后,我在此处新建一个项目,然后新建一个类,叫 TestTitleComment,用来验证添加头部注释以后的效果。

 

 

 

 

5、如下图所示,在模板配置的信息,自动解析到咱们新建的类文件里面去了。

1995789-20211114184820593-654071017.png

 

6、以上只是修改了代码模板的新建类文件,如果需要修改其他模板,需要在其他模板里面进行进一步修改。以下再举个Winform窗体的例子。在Windows Form文件夹下,找到form文件夹下的form文件,进行修改。

1995789-20211114184835595-614992800.png

 

7、打开form文件,并添加同上面class文件的头部注释有关信息,并保存。

1995789-20211114184847783-1130624973.png

 

8、测试效果,此处新建一个winform项目,新建以后为了测试效果,再添加一个验证结果的窗体,例如叫TestCommentForm,如下图所示。


1995789-20211114184902369-1187296847.png


调皮的分割线…………………… 

 1995789-20211114184918926-1853916127.png

 

9、添加窗体以后,打开对应窗体的代码文件,如下图所示,和配置文件信息一致。

1995789-20211114184926557-657322707.png

 

10、其他代码文件的配置信息,如上类似,各位大佬可以自行研究,祝大佬们好运。


目录
相关文章
|
4月前
webstorm【实用教程】代码自动格式,格式化时清除空行,修改使用代码模板
webstorm【实用教程】代码自动格式,格式化时清除空行,修改使用代码模板
413 2
犯的一个bug粗心错误-common的样式重复书写了,导致怎么也无法修改样式,导致样式怎么也写不好,还得信息哦
犯的一个bug粗心错误-common的样式重复书写了,导致怎么也无法修改样式,导致样式怎么也写不好,还得信息哦
|
6月前
Word标题跟随正文样式缩进的解决办法
Word标题跟随正文样式缩进的解决办法
150 2
自 创 日 历 (在代码里有注释讲细节)
做日历主要是要确定好第一天是星期几,然后算间隔多少天,算出具体这一天是星期几,然后把我们想打印的打印出来,把每个月的第一天定位到该在的地方。
77 0
webstorm 自定义注释内容
webstorm 自定义注释内容
585 0
webstorm 自定义注释内容
ProGuard混淆时保留注释(@类内容)
ProGuard混淆时保留注释(@类内容)
171 0
|
PHP 开发工具 git
VsCode 添加文件头部注释和函数注释[koroFileHeader]
koroFileHeader 在vscode中用于生成文件头部注释和函数注释的插件,经过多版迭代后,插件:支持所有主流语言,灵活方便,文档齐全,食用简单!觉得插件不错的话,就给个Star⭐️吧~ 文件头部添加注释: 在文件开头添加注释,记录文件信息/文件的传参/出参等 支持用户高度自定义注释选项, 适配各种需求和注释。 保存文件的时候,自动更新最后的编辑时间和编辑人 快捷键:window:ctrl+alt+i,mac:ctrl+cmd+i
3373 0
VsCode 添加文件头部注释和函数注释[koroFileHeader]
phpstorm设置文件和函数头部注释
phpstorm设置文件和函数头部注释
359 0
phpstorm设置文件和函数头部注释
AddBook 类的简单修改(增加注释文…
AddBook 类的简单修改(增加注释文…
146 0
|
Linux C# C++
VS2017 自动添加头部注释教程——Chinar出品
VS2017 自动添加头部注释教程——Chinar出品 VS 脚本自动添加头部注释 本文提供全流程,中文翻译。 助力快速完成 VS 添加脚本是自动填写头部注释 要让VS帮我们自动填写头部注释,我们只需要修改一下 VS 相应语言脚本模板中的文件信息即可 我们以 C# 脚本为例: 找到 VS...
7442 0