Vs 设置类、接口默认创建的模板

最新推荐文章于 2024-06-27 20:04:26 发布

原创最新推荐文章于 2024-06-27 20:04:26 发布 · 3.2k 阅读

9 ·

CC 4.0 BY-SA版权

文章标签：

#模板设置 #代码模板

.Net 专栏收录该内容

12 篇文章

订阅专栏

本文介绍如何自定义Visual Studio创建类和接口时使用的模板，通过修改模板文件，可以在生成的代码中自动包含注释、公共成员和其他常用元素。

一、前言

有些时候，我们希望Vs 在创建类，接口的时候，生成的代码文件能更丰富一下，例如：自动增加基础的注释功能，类文件自动增加 public 修饰符，类文件自动增加无参构造函数等等。其实VS生成这类文件都是有一个基础模板的，我们只需要修改VS的模板文件即可。

二、模板设置

1、模板路径

由于每个人安装的VS版本（例如：VS2022 、VS2019等），VS 类型（专业版、社区版、企业版等等）不同，会导致模板的存放路径也不一样，所以下述路径是我本机的路径，不过总体来说是大同小异的，只需要耐心的找一下即可。

类模板文件路径：

C:\Program Files\Microsoft Visual Studio\2022\Community\Common7\IDE\ItemTemplates\CSharp\Code\2052\Class\Class.cs

接口模板文件路径：

C:\Program Files\Microsoft Visual Studio\2022\Community\Common7\IDE\ItemTemplates\CSharp\Code\2052\Interface\Interface.cs

2、设置模板默认内容

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$
{
    /// <summary>
    /// 接口名称 ：  $safeitemrootname$
    /// 创 建 人 ：  $username$
    /// 创建时间 ：  $time$ 
    /// 描    述 ：  
    /// </summary>
    public class $safeitemrootname$
    {
        /// <summary>
        /// 无参构造函数
        /// </summary>
        public $safeitemrootname$()
        { 
        }
    }
}

3、参数列表

更多参数请看微软官方文档：项目和项模板参数 - Visual Studio (Windows) | Microsoft Docs

变量名称	备注
$time$	以 DD/MM/YYYY 00:00:00 格式表示的当前时间
$year$	年份
$clrversion$	CLR版本
$GUID$	用于替换项目文件中的项目 GUID 的 GUID。最多可以指定 10 个唯一的 GUID（例如，guid1)）
$itemname$	用户在对话框中提供的名称
$machinename$	当前的计算机名称
$projectname$	用户在对话框中提供的名称
$rootnamespace$	当前项目的根命名空间。此参数用于替换正向项目中添加的项中的命名空间
$safeitemname$	用户在“添加新项”对话框中提供的名称，名称中移除了所有不安全的字符和空格
$safeprojectname$	用户在“新建项目”对话框中提供的名称，名称中移除了所有不安全的字符和空格
$userdomain$	当前的用户域
$username$	当前的用户名