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 // ////////////////////////////////////////////////////////////////////

感谢大伙的阅读。