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$
    {
    }
}

5. 同樣的方式，設置接口的模板代碼注釋，這里就不演示了。只是需要注意的是，修改后需要以管理員身份進行保存。

6. 接下來我們重啟下vs,然后創建一個class文件試下吧，如下所示：

   

7. 至此，我們已經設置完成了。趕緊試試吧。

最后的最后，給你們幾個比較大膽的注釋模板：

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

感謝大伙的閱讀。