vs2017通過子產品檔案添加自定義注釋

有時我們在VS裡建立類和接口時,需要添加比較規範的注釋資訊,而每次都要複制粘貼比較麻煩,是以需要我們的IDE做一些支援,比較修改VS裡自定義的注釋模式,以添加自己公司需要的資訊格式.

注釋比較規範,是如何實作的呢?首先要知道,當你建立一個VS檔案時,事實上是調用了對應的模版檔案,我們以vs2017為例,來說一下添加自定義注釋的方法

子產品檔案位置

接口模版：C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\Common7\IDE\ItemTemplates\CSharp\Code\2052\Interface

類模版：C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\Common7\IDE\ItemTemplates\CSharp\Code\2052\Class

子產品檔案資訊

using System;
using System.Collections.Generic;
$if$ ($targetframeworkversion$ >= 3.5)using System.Linq;
$endif$using System.Text;
$if$ ($targetframeworkversion$ >= 4.5)using System.Threading.Tasks;
$endif$
namespace $rootnamespace$
{
    /// <summary>
    /// 功能描述    ：$safeitemrootname$  
    /// 創 建 者    ：$username$
    /// 建立日期    ：$time$ 
    /// 最後修改者  ：$username$
    /// 最後修改日期：$time$ 
    /// </summary>
    class $safeitemrootname$
    {
    }
}

其中有一些條件的預判斷，如果運作時的版本來引用不同的命名空間，如果我們有自己的子產品類庫，也可以在這裡引進來，$safeitemrootname是類的檔案名稱,$user是目前登陸使用者名，$time是目前日期時間。

修改模版之後，我們就可以建立類檔案了，看一下注釋就加上了，不用從新安裝模版devenv /InstallVsTemplates，這個指令在vs2017裡不需要了！

感謝各位的閱讀！

作者：倉儲大叔，張占嶺，

榮譽：微軟MVP

QQ：853066980

支付寶掃一掃，為大叔打賞!