VS2013 修改模板文件,增長默認註釋

vs中的///文檔註釋相似java中/** */文檔註釋。能自動的生成幫助文檔。html

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

 

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

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

這裏和網上的說法有些不一樣,網上省了\Code\目錄,也許vs2008沒有這個目錄。post

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

複製代碼
 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$ 都是系統的變量,模板參數是要區分大小寫的,你們須要注意。系統提供的可用的參數以下:spa

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

GUID [1-10] 用於替換項目文件中的項目 GUID 的 GUID。最多能夠指定 10 個惟一的 GUID(例如,guid1))。code

itemname 用戶在添加新項對話框中提供的名稱。htm

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模板下的內容(他不能還原)。

 

 

修改VS自帶的模版文件
在新建一個.cs類時,想要自定義其模版中的代碼,修改類的訪問權限,能夠經過修改安裝目錄中的模版文件來實現。找到以下的路徑,而後找到相應的模版文件進行修改。
D:\Program Files\visual-studio\Common7\IDE\ItemTemplates\CSharp\Code
注意,要把zip文件拷貝出來,而後解壓,修改其中的模版文件Class.cs,而後再打包成zip文件去目錄中覆蓋原來的文件,而不能是在目錄中直接用解壓軟件打開zip文件而後修改其中Class.cs的內容,由於這樣,只是修改了內存中的內容,而沒有真正修改zip文件中Class.cs的內容http://www.cnblogs.com/mcgrady/p/3749584.htmlhttp://www.cnblogs.com/anderslly/archive/2009/01/18/vs2008-templates.html
相關文章
相關標籤/搜索