天天看点

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

欢迎加入QQ群:

群号:1079830632

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

继续阅读