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

依樂祝發表於2019-07-04

在日常開發過程中，難免有這樣一種需求：就是你所建的每一個類檔案或者介面檔案都需要標註下作者姓名以及類的用途。如果我們每次建立檔案的時候都需要寫一遍這些資訊是很煩神的。還好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版本可能路徑要做適當的調整，具體怎麼調整，我想聰明如你，應該能夠理解。

    1562219147567

  2. 定位到上面路徑後，看到如下的檔案結構，這裡大致介紹一下檔案結構，這裡我們只進行類以及介面，WebClass的模板程式碼註釋的設定，至於其他的可自行選擇設定：

    1562219294264

  3. 我們開啟Class資料夾，看到如下的兩個檔案，選擇.cs結尾的檔案並開啟。如下所示：

    1562219404140

  4. 開啟後，會看到如下所示的程式碼：

    1562219528824

這時候我們在頂部加入我們的註釋模板檔案，如下所示：

1562219622876

具體文字程式碼如下，當然你可以根據自己的喜好，自由設定註釋模板，文章最後我會給出幾個比較浪的模板：

/*
*┌────────────────────────────────────────────────┐
*│　描    述：$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檔案試下吧，如下所示：

    1562219920638

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

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

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

感謝大夥的閱讀。

相關文章