自定义 Visual Studio .NET 2003 中的 C# 向导模板

Jónas Antonsson

2.33/5 (5投票s)

2005年8月5日

3分钟阅读

40493

如何自定义 VS.NET 2003 C# 模板以适应默认注释和 Visual SourceSafe 关键字。

引言

这是一篇关于有趣主题的非常简短的文章。它旨在展示更改在 Visual Studio .NET 2003 中创建新项目时使用的默认 C# 模板是多么容易。例如，如果您想在所有类中包含固定注释或使用 Visual Source Safe 关键字在每个类文件中生成日志历史记录，这将非常有用。

安装

大多数程序员必须遵循一些以公司为中心的编程程序，我并不例外。在我工作的地方，我们必须在我们创建的所有类中包含固定的注释标题，并且我们使用 Visual SourceSafe 关键字来跟踪类文件中的类历史记录（VSS 关键字是一种允许 VSS 将某些信息直接放入您的文件中以为您创建文件标题的方法）。

墨菲定律——当然，经常发现到处都是不符合规定的类。人们忘记添加注释、关键字或两者兼而有之。因此，我们想到了更改类创建的 Visual Studio 模板文件。这项工作的成果是本文的主要主题。

背景

我想明确一点，本文并不侧重于 VSS 关键字或 Visual Studio .NET 向导模板的技术解释。其他文章或资源已经涵盖了这些问题，因此添加我的观点可能会有点冗余。如果您想熟悉向导模板或 VSS 关键字，请访问“更多信息”部分中的链接。

重点

C# 的向导模板文件位于以下目录：[Visual Studio .NET 2003 安装目录]\VC#\VC#Wizards。在我的情况下，这将转换为：C:\Program Files\Microsoft Visual Studio .NET 2003\VC#\VC#Wizards。每个 [...Wiz] 目录包含“Templates\1033”目录。“1033”目录包含相应向导的模板文件。如果我想更改本地计算机上普通类的模板，我将编辑以下文件：C:\Program Files\Microsoft Visual Studio .NET 2003\VC#\VC#Wizards\CSharpClassWiz\Templates\1033\NewCSharpFile.cs。相对容易。因此，我的类模板的编辑版本包括默认注释和几个 VSS 关键字。它看起来像这样

/* 
* $Header: $
* $Log: $ 
*/
using System;
namespace [!output SAFE_NAMESPACE_NAME]
{
    /// <summary>
    /// Summary description for [!output SAFE_CLASS_NAME].
    /// <para>Copyright (C) 2005 Jónas Antonsson - My Company ltd.</para>
    /// </summary>
    public class [!output SAFE_CLASS_NAME]
    {
        /// <summary>
        /// Default constructor.
        /// </summary>
        public [!output SAFE_CLASS_NAME]()
        {
        }
    }
}

扩展使用

当然，这篇简短的文章重点关注 C#。其他 VS.NET 2003 支持语言的向导模板也很容易定制。例如，我的 Visual Basic 或 J# 向导模板可以在这里找到

C:\Program Files\Microsoft Visual Studio .NET 2003\Vb7\VBWizards
C:\Program Files\Microsoft Visual Studio .NET 2003\VJ#\vjsharpwizards

请注意，这些是从我的系统设置中导出的绝对路径。

修订历史

2005 年 8 月 7 日
- 添加了一些章节来为文章建立上下文。
- 添加了“修订历史记录”。