September 14, 2012

修改Visual Studio內建樣版

團隊開發時,我們常會需要遵循一些開發原則或coding standard/convention。例如在類別中,檔案最上方需要加入一些針對類別的描述文字如
//------------------------------------------------------------------------------
// Description: A generic repository that should be derived in domain repositories
// Created by: Pete
// Created on: Sep 10, 2012
//------------------------------------------------------------------------------
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

通常很常見的作法就是加入一個新類別後,再去找一個已存在專案中的類別,複制它的描述後再貼到這個新建的類別中,每建一個新類別這樣的複制貼上動作就要再做一次。何不去修改內建的VS樣版,讓我們在新增新類別時幫我們自動加上一些基本的說明呢?

以下步驟說明如何透過修改類別的內建樣板加入上述的描述文字

  1. 關閉VS
  2. 瀏覽樣板檔案位置(筆者的VS版本是2010,作業系統版本是Windows 7 32-bit)
    C:\Program Files\Microsoft Visual Studio 10.0\Common7\IDE\ItemTemplates\CSharp\Code\1033
  3. 備份Class.zip
  4. 將Class.zip解壓縮
  5. 修改Class.cs,將類別描述文字加入至類別最上方並儲存
  6. 將修改後的Class.cs覆蓋回原本Class.zip裡的Class.cs
  7. 執行C:\Program Files\Microsoft Visual Studio 10.0\Common7\IDE>devenv.exe /installvstemplates
  8. 啟動VS
設定完成後於VS新增一類別,此時將會看到描述文字已被加入至類別最上方
//------------------------------------------------------------------------------
// Description:
// Created by:
// Created on:
//------------------------------------------------------------------------------
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

namespace AdventureWorks.Client.Console
{
    class Class1
    {
    }
}

No comments: