Visual Studio模板代码注释小技巧分享

在日常开发过程中，难免有这样一种需求：就是你所建的每一个类文件或者接口文件都需要标注下作者姓名以及类的用途。如果我们每次创建文件的时候都需要写一遍这些信息是很烦神的。还好Visual Studio给我们提供了模板注释的功能来自动帮我们生成类似的注释代码。今天趁着中午休息的时间就让我们一起来操作下吧。

作者：依乐祝
原文链接：https://www.cnblogs.com/yilezhu/p/11132090.html

1. 首先定位到你的VS的安装目录：C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\Common7\IDE\ItemTemplates\CSharp\Code\2052 这里根据你的vs版本可能路径要做适当的调整，具体怎么调整，我想聪明如你，应该能够理解。

   

2. 定位到上面路径后，看到如下的文件结构，这里大致介绍一下文件结构，这里我们只进行类以及接口，WebClass的模板代码注释的设置，至于其他的可自行选择设置：

   

3. 我们打开Class文件夹，看到如下的两个文件，选择.cs结尾的文件并打开。如下所示：

   

4. 打开后，会看到如下所示的代码：

   

这时候我们在顶部加入我们的注释模板文件，如下所示：

具体文本代码如下，当然你可以根据自己的喜好，自由设置注释模板，文章最后我会给出几个比较浪的模板：

/*
*┌────────────────────────────────────────────────┐
*│　描    述：$safeitemrootname$                                                    
*│　作    者：lzhu                                              
*│　版    本：1.0                                              
*│　创建时间：$time$                        
*└────────────────────────────────────────────────┘
*/
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$
{
    public class $safeitemrootname$
    {
    }
}

1. 同样的方式，设置接口的模板代码注释，这里就不演示了。只是需要注意的是，修改后需要以管理员身份进行保存。

2. 接下来我们重启下vs,然后创建一个class文件试下吧，如下所示：

   

3. 至此，我们已经设置完成了。赶紧试试吧。

最后的最后，给你们几个比较大胆的注释模板：

//                          _ooOoo_                               //
//                         o8888888o                              //
//                         88" . "88                              //
//                         (| ^_^ |)                              //
//                         O\  =  /O                              //
//                      ____/`---'\____                           //
//                    .'  \\|     |//  `.                         //
//                   /  \\|||  :  |||//  \                        //
//                  /  _||||| -:- |||||-  \                       //
//                  |   | \\\  -  /// |   |                       //
//                  | \_|  ''\---/''  |   |                       //
//                  \  .-\__  `-`  ___/-. /                       //
//                ___`. .'  /--.--\  `. . ___                     //
//              ."" '<  `.___\_<|>_/___.'  >'"".                  //
//            | | :  `- \`.;`\ _ /`;.`/ - ` : | |                 //
//            \  \ `-.   \_ __\ /__ _/   .-` /  /                 //
//      ========`-.____`-.___\_____/___.-`____.-'========         //
//                           `=---='                              //
//      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^        //
//                   佛祖保佑       永不宕机     永无BUG          //

感谢大伙的阅读。

作者：依乐祝（祝雷）

出处：https://www.cnblogs.com/yilezhu

联系：1015657114@qq.com .NET Core实战项目交流群：637326624 微信：jkingzhu

本文版权归作者和博客园共有，欢迎转载，但未经作者同意必须保留此段声明，且在文章页面明显位置给出原文连接，否则保留追究法律责任的权利。如有问题或建议，请多多赐教，非常感谢。

补充另外一个比较规范的注释模板1：

#region << 版 本 注 释 >>
/*
     * ========================================================================
     * Copyright Notice  2021-$year$ xxx.com All rights reserved .
     * ========================================================================
     * 机器名称：$machinename$ 
     * 文件名：  $safeitemrootname$ 
     * 版本号：  V1.0.0.0 
     * 创建人：  $username$ 
     * 创建时间： $time$ 
     * 描述    :
     * =====================================================================
     * 修改时间：$time$ 
     * 修改人  ： $username$
     * 版本号  ： V1.0.0.0 
     * 描述    ：
*/
#endregion

补充另外一个比较规范的注释模板2：

#region << 版 本 注 释 >>
/************************************************************************
* 版权所有  (c)   $year$ xxx 保留所有权力.
* CLR版本     		：$clrversion$
* 机器名称    		：$machinename$
* 公司名称    		: xxx
* 命名空间    		：$rootnamespace$
* 唯一标识          ：$guid10$
* 文件名称    		：$safeitemname$
* 版本号      		: $year$|V1.0.0.0 
*========================================================================
* 创 建 者    		：@ $username$
* 创建日期    		：$time$
* 电子邮箱    		：xxx
* 功能描述    		：
* 使用说明    		：
*========================================================================
* 修改者      		：@ $username$
* 修改日期    		：$time$
* 电子邮箱    		：xxx
* 版本号      		: $year$|V1.0.0.0 
* 修改描述    		：
*========================================================================
**************************************************************************/
#endregion

另外补充说明一下，如果修改了安装目录下C:\Program Files (x86)\Microsoft Visual Studio\2019\Enterprise\Common7\IDE\ItemTemplates\CSharp\Code\2052还不行，则把目录C:\Program Files (x86)\Microsoft Visual Studio\2019\Enterprise\Common7\IDE\ItemTemplates\CSharp\Code\1033也同步修改一下就可以了。