在開發項目的時候,由其是商業性質的大型項目時,往往需要在每個代碼文件上都加上一段關於版權、開發人員的信息,並且名稱空間上都需要帶有公司的標志。這個時候,是選擇在開發的時候手動添加還是自動生成呢?
我們其實完全可以利用 Visual Studio 提供的模板工具自定義一套專屬的模板。
假如當我添加一個 .cs 文件後,我希望默認添加的文件要看起來像這個樣子:
如何實現
1. 隨意新建一個工程或使用一個已經存在的工程,在該項目內新添加一個普通的 class 文件,打開後應該和下圖長得差不多。
2. 修改這個文件,讓它看起來和我們的目標模板越像越好。
#region 版權信息 /* * ----------------------------------------------------------- * Copyright (c) 2014 chenxu.me All rights reserved. * ----------------------------------------------------------- * * 創建者: $username$ * 創建時間: $time$ * CLR: $clrversion$ * */ #endregion using System; using System.Collections.Generic; using System.Linq; using System.Text; using System.Threading.Tasks; namespace Charley.$rootnamespace$ { class Class1 { } }
有一部分信息,例如時間,是沒辦法在寫模板的時候就知道的,這個只能在生成文件的時候才能知道。此類動態的數據,Visual Studio 提供了一堆占位符供我們使用。
上圖只是其中一部分,更多請查看文後的參考資源
3. 導出模板
3.1 選擇 文件 / 導出模板...
3.2 選擇項目模板
3.3 選擇我們要導出的模板
3.4 不用勾選
3.5 修改模板名稱等信息,同時勾選 “自動導入到 Visual Studio ” 中
3.6 點擊完成,Visual Studio 便開始生成模板 (zip文件)
4. 檢查下效果
新增文件的時候,就會找到我們自己的模板
文件中的占位符已經被正確替換
整個過程和自定義項目模板類似,只不過自定義工程模板的時候需要根據預期的模板工程新建一個對應的工程。這裡我以類庫項目為例進行介紹。
因為是針對整個工程來說,所以記得把所有需要修改的文件都要進行修改,修改方式參考自定義項目模板。
修改代碼
選擇工程模板
填寫信息
當下一次添加新的工程時候,就會發現新的模板。
文件中的信息已經被正確替換了