VS2022 可以自动生成文件注释
我们需要生成的文件 注释中必须添加的内容有:版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等,头文件的注释中还应有函数功能简要说明。
操作方法:
1)定位到VS的安装目录如
C:\Program Files\Microsoft Visual Studio\
2)在VS安装路径下依次找到这些文件夹:
\Common7\IDE\ItemTemplatesCache
3)根据你具体使用的编程语言来修改下面具体的文件夹,如c#
CSharp\Code\2052\Class\Class.cs
4)在文件开头加上你想要的注释,如
/// <summary>
///类 名 称:$itemname$
///命名空间:$rootnamespace$
///
///clr版本号:$clrversion$
///创建人: $username$
///创建时间:$time$
///描述:
/// </summary>
5)模版中主要参数说明
参数 | 描述 |
clrversion | 当前系统CLR版本号 |
GUID [1-10] | 生成全局唯一标识符,可以生成10个 (例如:guid1) |
itemname | 打开添加新建项时输入的文件名称 |
machinename | 当前机器的名称(如:XXXX) |
registeredorganization | 注册的组织名 |
rootnamespace | 命名空间名 |
safeitemname | 保存的文件名 |
time | 当前系统时间,格式:DD/MM/YYYY 00:00:00. |
userdomain | 用户所在的域 |
username | 当前系统用户名 |
year | 当前系统时间 YYYY |