關於Visual Studio 20**自動添加頭部注釋信息

作為一個萬年潛水黨，不管這一篇文章技術含量如何，也算是一個好的開始吧。

 

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

 

首先找到Visual Studio 20**的安裝路徑下\Common7\IDE\ItemTemplatesCache\CSharp\目錄
Windows Forms是開發Windows Forms程序的模版目錄，Code是類庫項目文件的模版目錄，其他的同理。進入Code目錄有選擇2052目錄下，會看到多個帶有.zip的目錄，比如我要修改類文件模版，就修改\Class.zip\Class.cs，打開Class.cs會看到如下內容。

 

快速定位vs安裝目錄↓

vs2010：%ProgramFiles%\Microsoft Visual Studio 10.0\Common7\IDE\ItemTemplatesCache\CSharp

vs2008：%ProgramFiles%\Microsoft Visual Studio 9.0\Common7\IDE\ItemTemplatesCache\CSharp

vs2005：%ProgramFiles%\Microsoft Visual Studio 8\Common7\IDE\ItemTemplatesCache\CSharp

 

copy到地址欄回車即可，方便快捷。(vs2010的我已經測試過了，可以使用，其他的應該也沒問題)

 

Class.cs 模版源文件內容

using System;
using System.Collections.Generic;
$if$ ($targetframeworkversion$ >= 3.5)using System.Linq;
$endif$using System.Text;
 
namespace $rootnamespace$
{
 class $safeitemrootname$
 {
 }
}

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

 

$time$     　　　　日期

$year$     　　　　年份

$clrversion$    　CLR版本

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

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

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

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

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

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

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

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

$userdomain$  當前的用戶域。

$username$  當前的用戶名。

等等...

 

模版更新后內容：

#region 描述
//----------------------------------------------------------------------------- // 文 件 名: $safeitemrootname$ // 作 者：[author name] // 創建時間：$time$ // 描 述： // 版 本： //----------------------------------------------------------------------------- // 歷史更新紀錄 //----------------------------------------------------------------------------- // 版 本： 修改時間： 修改人： // 修改內容： //----------------------------------------------------------------------------- // Copyright (C) 20013-$year$ 某某公司 //-----------------------------------------------------------------------------
#endregion
using System; using System.Collections.Generic; $if$ ($targetframeworkversion$ >= 3.5)using System.Linq; $endif$using System.Text; namespace $rootnamespace$ { class $safeitemrootname$ { } }

 

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

 

以上模版中注釋樣式可以根據需要對其進行修改。

 

補充：

   上面提到的2052目錄：是國家/地區語言代碼的十進制，中國地區代碼為2052。