Visual Studio模板代碼註釋小技巧分享

在平常開發過程當中，不免有這樣一種需求：就是你所建的每個類文件或者接口文件都須要標註下做者姓名以及類的用途。若是咱們每次建立文件的時候都須要寫一遍這些信息是很煩神的。還好Visual Studio給咱們提供了模板註釋的功能來自動幫咱們生成相似的註釋代碼。今天趁着中午休息的時間就讓咱們一塊兒來操做下吧。

做者：依樂祝
原文連接：http://www.javashuo.com/article/p-vpuuzttq-hd.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          //
////////////////////////////////////////////////////////////////////

感謝大夥的閱讀。