VS在C#類文件頭部添加文件注釋的方法

一、使用代碼模板

步驟：

1.VS2012 中找到（安裝盤符以C盤為例）

64位操作系統路徑：C:\Program Files（X86）\Microsoft Visual Studio 10.0\Common7\IDE\ItemTemplatesCache\CSharp\Code\2052\Class.zip

Code文件夾指類代碼，Class文件夾指類文件、Interface文件夾指接口文件。 2052文件夾下的每個文件的.cs文件都加也行。。

若路徑是：

C:\Program Files (x86)\Microsoft Visual Studio 11.0\Common7\IDE\ItemTemplatesCache\CSharp\Windows Forms\2052\Form

則是添加窗體的時候，自動加注釋。

2.在Class.cs 文件中添加如下代碼。

/*************************************************************************************
 *
 * 文 件 名:   $safeitemname$
 * 描    述: 
 * 
 * 版    本：  V1.0
 * 創 建 者：  $username$ 
 * 創建時間：  $time$
 * ======================================
 * 歷史更新記錄
 * 版本：V          修改時間：         修改人：
 * 修改內容：
 * ======================================
*************************************************************************************/

$safeitemname$、$rootnamespace$ 這些參數都是系統變量，功能類似於Foxmail模版里面的宏。

其他可用的參數有：（需要注意：這些參數區分大小寫！）

3.這樣在新建c#類文件時就會自動添加注釋說明信息了。

二、使用VS的擴展插件

License Header Manager許可證頭管理器允許你：

• 定義每個 Visual Studio 項目和每個文件擴展名的許可頭
• 通過add添加為鏈接可在項目之間共享許可頭
• 添加，刪除和替換一個或者全部文件的標題
• 將你的許可證頭放在 #regions 中
• 像%FileName%, %Project% or %UserName% 等使用使用擴展特性，並且在每次重新插入標題時自動填充

源代碼網址:http://www.github.com/rubicon-oss/LicenseHeaderManager
文檔：https://github.com/rubicon-oss/LicenseHeaderManager/wiki

1、安裝License Header Manager擴展，將許可證標頭添加到項目中。

在VS2013以上的擴展菜單中，搜索添加此插件進行安裝。

2、設置：

注意：勾選在新建文件時自動插入文件頭部。取消勾選“至少有如下的一個關鍵字時才可以移除頭部”。

設置默認頭部，以C#為例，編輯如下的代碼到下面所示文本框中。

extensions: .cs
/*************************************************************************************
 *
 * 文 件 名:   %FileName%
 * 描    述: 
 * 
 * 版    本：  V1.0
 * 創 建 者：  %UserName%
 * 創建時間：  %CreationYear%/%CreationMonth%/%CreationDay% %CreationTime%
 * ======================================
 * 歷史更新記錄
 * 版本：V          修改時間：         修改人：
 * 修改內容：
 * ======================================
*************************************************************************************/

 默認頭部框，點擊右下角的編輯按鈕進行修改。

可用的擴展屬性：

• ％FullFileName％擴展為完整的文件名（包括目錄路徑），
• ％FileName％擴展為文件名，
• ％CreationYear％，％CreationMonth％，％CreationDay％，％CreationTime％擴展為各自的文件創建DateTime屬性（時間為（以短時間格式），
• ％CurrentYear％，％CurrentMonth％，％CurrentDay％，％CurrentTime％擴展為各自的當前DateTime屬性（時間為短時間格式），
• ％UserName％擴展為當前名稱（登錄）用戶
• ％Project％擴展到包含項目的名稱（從1.4開始）
• ％Namespace％擴展到文件中使用的第一個命名空間（從1.4開始）
• ％UserDisplayName％擴展到當前用戶的全名（從1.6開始）

3、如果需要，請指定注釋語法並跳過表達式使用其他語言。

工具/選項/許可證標頭：在選項頁面上，您可以配置LHM並定義新語言的注釋語法。

4、插入許可證標題。 

一旦安裝了License Header Manager擴展，就可以在幾個不同的位置訪問其功能：

1. 編輯/高級：
   
2. 解決方案資源管理器中的項目上下文菜單。
   
3. 解決方案資源管理器中的解決方案上下文菜單：
   

5、使用定義文件

1. 在項目中為文件增加頭部時，會彈出如下的對話框。

    

2. 點擊是，自動為項目創建一個繼承自默認頭部項目專屬的頭部定義文件。可以更改此定義文件內容。

    

3. 此時，項目文件已經有頭部了。