Visual Studio自动添加头部注释

时间:2023-03-09 01:47:04
Visual Studio自动添加头部注释

VS2013 自动添加头部注释

1、找到VS2013的安装目录

下文以安装目录 C:\Program Files (x86)\Microsoft Visual Studio 12.0 为例

2、修改Class模板。下面以修改CSharp模板为例

打开Class模板所在目录C:\Program Files (x86)\Microsoft Visual Studio 12.0\Common7\IDE\ItemTemplatesCache\CSharp\Code\2052\Class,修改Class.cs文件,增加注释模板,如下图所示。

Visual Studio自动添加头部注释

Visual Studio自动添加头部注释

注释模板

/********************************************************************************************

            版权所有    :
            文件名      :$safeitemrootname$
            创建日期    :$time$
            作者        :$username$
            功能说明    :N/A

   版本    日期         修改人      修改内容
---------------------------------------------------------------------------------------------
 *V1.00                 $username$    初始版本

********************************************************************************************/
using System;
using System.Collections.Generic;
$if$ ($targetframeworkversion$ >= 3.5)using System.Linq;
$endif$using System.Text;
$if$ ($targetframeworkversion$ >= 4.5)using System.Threading.Tasks;
$endif$

namespace $rootnamespace$
{
    class $safeitemrootname$
    {
    }
}

代码中的"$"符号之间的字符是模版的变量,具体变量含义请参照:

/*
$year$  显示当前年份
$time$ 以 DD/MM/YYYY 00:00:00 格式表示的当前时间。

$machinename$ 当前的计算机名称(例如,Computer01)。
$userdomain$ 当前的用户域。
$username$ 当前的用户名。

$rootnamespace$ 当前项目的根命名空间。此参数用于替换正向项目中添加的项中的命名空间。
$safeprojectname$ 用户在“添加新项目”对话框中提供的名称,名称中移除了所有不安全的字符和空格。
$safeitemname$ 用户在“添加新项”对话框中提供的名称,名称中移除了所有不安全的字符和空格。
$itemname$ 用户在“添加新项目”对话框中提供的名称。
$projectname$ 用户在“添加新项”对话框中指定的名称。

$clrversion$  当前CLR版本
$GUID [1-10]$ 用于替换项目文件中的项目 GUID 的 GUID。最多可以指定 10 个唯一的 GUID(例如,guid1))。
$registeredorganization$ HKLM\Software\Microsoft\Windows NT\CurrentVersion\RegisteredOrganization 中的注册表项值。
*/

其他资料链接:

VS2013 添加文件头部注释模板

VS2015自动生成代码注释以及VA_X安装使用教程

VS2015 自动添加头部注释