Visual Studio 自動添加頭部注釋信息

在日常的開發中我們經常需要為我們的類庫添加注釋和版權等信息，這樣我們就需要每次去拷貝粘貼同樣的文字，為了減少這種重復性的工作，我們可以把這些信息保存在 Visual Studio 2010 類庫模版文件里。

首先找到 Visual Studio 2010 的安裝路徑下 \Common7\IDE\ItemTemplatesCache\CSharp\ 目錄，如圖：

里面有好多目錄，Windows Forms 是開發 Windows Forms 程序的模版目錄，Web 是 Web 項目文件的模版目錄，其他的同理。

進入 Web 目錄有選擇 2052 目錄（2052 是中文地區的代號）下，會看到好多帶有 .zip 的目錄，比如我要修改 Web 頁面的模版，就修改 \WebForm.zip\Default.aspx.cs，打開 Default.aspx.cs 會看到如下內容。

using System;
using System.Collections.Generic;
$if$ ($targetframeworkversion$ >= 3.5)using System.Linq;$endif$
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;

namespace $rootnamespace$
{
    public partial class $classname$ : System.Web.UI.Page
    {
        protected void Page_Load(object sender, EventArgs e)
        {

        }
    }
}

代碼中的 "$" 符號之間的字符是模版的變量，具體變量含義請參照：

$time$     日期

$year$     年份

$clrversion$    CLR 版本

$GUID$   用於替換項目文件中的項目 GUID 的 GUID。最多可以指定 10 個唯一的 GUID（例如，guid1)）。

$itemname$  用戶在對話框中提供的名稱。

$machinename$    當前的計算機名稱（例如，Computer01）。

$projectname$   用戶在對話框中提供的名稱。

$registeredorganization$   HKLM\Software\Microsoft\Windows NT\CurrentVersion\RegisteredOrganization 中的注冊表項值。

$rootnamespace$  當前項目的根命名空間。此參數用於替換正向項目中添加的項中的命名空間。

$safeitemname$  用戶在“添加新項”對話框中提供的名稱，名稱中移除了所有不安全的字符和空格。

$safeprojectname$  用戶在“新建項目”對話框中提供的名稱，名稱中移除了所有不安全的字符和空格。

$time$    以 DD/MM/YYYY 00:00:00 格式表示的當前時間。

$userdomain$  當前的用戶域。

$username$  當前的用戶名。

下面是我寫注釋的格式，那我們就按照這個格式做一個模版。

// ===============================================================================
// Project Name        :    Weisenz.Core
// Project Description :    
// ===============================================================================
// Class Name          :    HttpModule
// Class Version       :    v1.0.0.0
// Class Description   :    
// Author              :    Charles
// Create Time         :    2012/3/29 13:19:28
// Update Time         :    2012/3/29 13:19:28
// ===============================================================================
// Copyright © Weisenz 2012 . All rights reserved.
// ===============================================================================

在對應的地方替換成自己需要使用的變量。

// ===============================================================================
// Project Name        :    $rootnamespace$
// Project Description :    
// ===============================================================================
// Class Name          :    $safeitemrootname$
// Class Version       :    v1.0.0.0
// Class Description   :    
// Author              :    $username$
// Create Time         :    $time$
// Update Time         :    $time$
// ===============================================================================
// Copyright © $machinename$ $year$ . All rights reserved.
// ===============================================================================

最后把上面的文本添加到 Default.aspx.cs 的最前面就行了。

下面是我的最終成果：

// ===============================================================================
// Project Name        :    Weisenz.Web
// Project Description :    
// ===============================================================================
// Class Name          :    Services
// Class Version       :    v1.0.0.0
// Class Description   :    
// Author              :    Charles
// Create Time         :    2012/3/29 13:38:53
// Update Time         :    2012/3/29 13:38:53
// ===============================================================================
// Copyright © Weisenz 2012 . All rights reserved.
// ===============================================================================
using System;
using System.Collections.Generic;

using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;

namespace Weisenz.Web
{
    public partial class Services : System.Web.UI.Page
    {
        protected void Page_Load(object sender, EventArgs e)
        {

        }
    }
}

如果需要修改其他的模版就按照上面的步驟找到對應的文件夾就行了。