1. 程式人生 > >VS中為程式檔案自動新增版權資訊註釋的方法

VS中為程式檔案自動新增版權資訊註釋的方法

         現在大多數公司都規定程式設計師在程式檔案的頭部加上版權資訊,這樣每個人寫的檔案都可以區分開來,如果某個檔案出現問題,就可以快速找到檔案的建立人,用最短的時間來解決問題。有些人用複製貼上的方式,這樣既浪費時間,效果又不是很好。一些高階的IDE工具提供修改程式碼模板的功能,這樣就能夠在建立新程式碼時自動加上版權資訊等。Visual Studio雖然沒有提供這樣的操作介面,但是我們可以手動修改原始程式碼模板來達到這個目的。下面就介紹下怎麼樣去自動新增這些資訊。

         以Visual Studio 2010為例:

1.      首先找到模板目錄,在VS2010的安裝路徑下,如C:\Program Files (x86)\Microsoft Visual Studio10.0\Common7\IDE\ItemTemplates,找到資料夾如圖所示:


裡面可以為各種語言進行修改,如果對WinForm中的類進行修改,可以開啟\ CSharp\Code\2052\ Class.zip。其中\ CSharp\Code\2052\包括了所有WinForm檔案型別的模板。注意路徑中的2052表示是中文版,如果是英文版應該是1033。

2.      修改模板,修改模板其實很簡單,就是把對應的Zip檔案解壓縮,修改裡面的CS檔案,然後重新壓縮成一樣的zip包。比如我修改的模板檔案如下:

    這裡面可以用一些引數,模板引數以 $引數$ 格式進行宣告。例如:

·        $safeprojectname$

·        $guid1$

下面列出可供所有模板使用的保留的模板引數

注意:模板引數區分大小寫。

引數

說明

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

當前的使用者名稱。

webnamespace

當前網站的名稱。在 Web 窗體模板中使用此引數以確保類名稱是唯一的。如果網站位於 Web 伺服器的根目錄下,則此模板引數將解析為 Web 伺服器的根目錄。

year

YYYY 格式表示的當前年份。

也可以自定義引數,這裡就不介紹了。

注意:可能完成上邊操作後,重新建立一個class的時候,發現VS並沒有使用我們定製的模板,這個原因就是一個快取問題。VS會在C:\Program Files(x86)\Microsoft Visual Studio 10.0\Common7\IDE\ItemTemplatesCache\資料夾中去尋找同名的模板檔案,所以我們要也把這裡改了,注意,這裡的.zip結尾的只是一個資料夾,並不是一個壓縮檔案。