[开发笔记]-Visual Studio 2012中为创建的类添加注释的模板

为类文件添加注释，可以让我们在写代码时能够方便的查看这个类文件是为了实现哪些功能而写的。

一：修改类文件模板

找到类模版的位置：C:\Program Files (x86)\Microsoft Visual Studio 11.0\Common7\IDE\ItemTemplates\CSharp\Code\2052\Class，打开Class.cs，为其添加头注释：

我自己的类注释模板为：

/* ==================================================================
* 类 名 称：$safeitemrootname$
* 版 本 号：v1.0.0
* 作 者: $username$
* 创建时间：$time$
* 类 说 明：
* 备 注：
*
* ==================================================================*/

注意：在win7以上系统中修改该Class.cs文件时需要以管理员身份运行编辑软件，否则会提示无法保存。

这里的$safeitemrootname$和$username$是由系统提供给我们的，还有一些其他参数：

参数 说明

clrversion 公共语言运行库 (CLR) 的当前版本。

itemname 用户在添加新项对话框中提供的名称。

machinename 当前的计算机名称（例如，Computer01）。

projectname 用户在新建项目对话框中提供的名称。

rootnamespace 当前项目的根命名空间。此参数用于替换正向项目中添加的项中的命名空间。

safeitemname 用户在“添加新项”对话框中提供的名称，名称中移除了所有不安全的字符和空格。

safeprojectname 用户在“新建项目”对话框中提供的名称，名称中移除了所有不安全的字符和空格。

time 以 DD/MM/YYYY 00:00:00 格式表示的当前时间。

userdomain 当前的用户域。

username 当前的用户名。

year 以 YYYY 格式表示的当前年份。

在Visual Studio 2012中添加新类后的效果：



转载请注明出处。