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里不需要了！

感谢各位的阅读！

本文转自博客园张占岭（仓储大叔）的博客，原文链接：vs2017通过模块文件添加自定义注释，如需转载请自行联系原博主。