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

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

 

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

 

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、其他代码文件的配置信息,如上类似,各位大佬可以自行研究,祝大佬们好运。


目录
相关文章
|
SQL 前端开发 安全
详细介绍前后端分离必备的接口规范,包括命名规范、参数规范、错误处理规范等
详细介绍前后端分离必备的接口规范,包括命名规范、参数规范、错误处理规范等
4078 1
|
Rust 算法 网络安全
【密码学】一文读懂CMAC
介于上一篇文章比较水,然后这个和上一篇也比较相似,CMAC是为了解决DAA当中安全性不足的问题而出现的,这个算法一共有三个密钥,K, K1, K2, 其中K1和K2可以由K导出,接下来就来一起看一下CMAC的具体过程吧,这一篇文章其实也不长。
5856 0
【密码学】一文读懂CMAC
|
监控 NoSQL
JLink + GDB 调试方法
本节主要介绍嵌入式开发中常用的JLink+GDB调试方法。 调试所需软件 J-link,可以从https://www.segger.com下载对应操作系统的软件包,然后安装(注意:segger是仿真器的名字,相当常用的一款,仿真器的接口也是固定的,一般开发版上都会带有这个调试接口,如图) 运行JLinkGDBServer 按照上图中的配置,配置GDBServer,然后点击OK,进入下一个界面 注意,如果硬件连接没有问题,那么上图中的J-Link和 Device栏中显示绿色,GDB显示为红色,因为我们还没有运行GDB软件。
9673 46
|
传感器 算法 数据格式
QT Modbus RTU调试助手(包含算法实现CRC MODBUS16校验)
QT Modbus RTU调试助手(包含算法实现CRC MODBUS16校验)
1738 0
|
7月前
|
安全 Linux 开发工具
Gitea Enterprise 24.8.0 发布 - 本地部署的企业级 Git 服务
Gitea Enterprise 24.8.0 (Linux, macOS, Windows) - 本地部署的企业级 Git 服务
378 1
Gitea Enterprise 24.8.0 发布 - 本地部署的企业级 Git 服务
|
前端开发 Linux C#
一款开源、免费、美观的 Avalonia UI 原生控件库 - Semi Avalonia
一款开源、免费、美观的 Avalonia UI 原生控件库 - Semi Avalonia
1930 10
|
算法 API C#
Winform控件优化之圆角按钮【各种实现中的推荐做法】(下)
最终优化实现ButtonPro按钮(继承自Button),既提供Button原生功能,又提供扩展功能,除了圆角以外,还实现了圆形、圆角矩形的脚尖效果、边框大小和颜色、背景渐变颜色...
4123 0
Winform控件优化之圆角按钮【各种实现中的推荐做法】(下)
【Qt 学习笔记】Qt窗口 | 标准对话框 | 颜色对话框QColorDialog
【Qt 学习笔记】Qt窗口 | 标准对话框 | 颜色对话框QColorDialog
3255 3
|
C++
Visual Studio Code 设置 doxygen 格式注释
vs code 使用 cschlosser.doxdocgen 插件,设置 doxygen 注释格式
4165 0
Visual Studio Code 设置 doxygen 格式注释
|
算法 计算机视觉
如何判断点在多边形内部:OpenCV--cv2.pointPolygonTest()方法详解
如何判断点在多边形内部:OpenCV--cv2.pointPolygonTest()方法详解

热门文章

最新文章