VS2010 修改模板文件,增加默認注釋


其實這篇文章是從網上轉載的,但是找不到轉載鏈接,只能自己復制過來了

 

vs中的///文檔注釋類似java中/** */文檔注釋。能自動的生成幫助文檔。

如果我想在每次創建文件時,自動生成文檔注釋(注意是自動生成文檔注釋而不是幫助文檔),如下面的代碼,需要設置VS的模板,新創建的cs類文件會根據模板的樣子進行生成。常用的VS文件模板有3個,分別是Class.zip、Interface.zip、From.zip.

 

我以Class.zip模板設置為例,模板在vs2010下的路徑

C:\Program Files (x86)\Microsoft Visual Studio 10.0\Common7\IDE\ItemTemplatesCache\CSharp\Code\2052\Class.zip

這里和網上的說法有些不同,網上省了\Code\目錄,也許vs2008沒有這個目錄。

雙擊打開Class.zip直接編輯Class.cs,不用解壓縮,編輯完保存。模板代碼設置如下:

 1 /* ==============================================================================
 2  * 功能描述:$safeitemrootname$  
 3  * 創 建 者:$username$
 4  * 創建日期:$time$
 5  * ==============================================================================*/
 6 using System;
 7 using System.Collections.Generic;
 8 $if$ ($targetframeworkversion$ >= 3.5)using System.Linq;
 9 $endif$using System.Text;
10 
11 namespace $rootnamespace$
12 {
13     /// <summary>
14     /// $safeitemrootname$
15     /// </summary>
16     public class $safeitemrootname$
17     {
18     }
19 }

這里$var$ 都是系統的變量,模板參數是要區分大小寫的,大家需要注意。系統提供的可用的參數如下:

參數  說明 clrversion 公共語言運行庫 (CLR) 的當前版本。

GUID [1-10] 用於替換項目文件中的項目 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 當前的用戶名。

year 以 YYYY 格式表示的當前年份。

保存並關閉,完成模板設置,會發現新創建的類文件如您所願。

其他vs版本的設置步驟相同。在vs根目錄下搜索Class.zip等模板文件的物理路徑

ItemTemplates與ItemTemplatesCache的區別在於,如果您設置了ItemTemplates下的模板,需要在VS命令行中運行devenv /setup 命令  ,以Itemtemplates模板生成ItemTemplatesCache的模板,也就是說ItemTemplatesCache模板的設置會被原始的Itemtemplates模板還原。所以最好不要輕易改變Itemtemplates模板下的內容(他不能還原)。


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM