VS在C#类文件头部添加文件注释的方法

一、使用代码模板

步骤：

1.VS2012 中找到（安装盘符以C盘为例）

64位操作系统路径：C:\Program Files（X86）\Microsoft Visual Studio 10.0\Common7\IDE\ItemTemplatesCache\CSharp\Code\2052\Class.zip

Code文件夹指类代码，Class文件夹指类文件、Interface文件夹指接口文件。 2052文件夹下的每个文件的.cs文件都加也行。。

若路径是：

C:\Program Files (x86)\Microsoft Visual Studio 11.0\Common7\IDE\ItemTemplatesCache\CSharp\Windows Forms\2052\Form

则是添加窗体的时候，自动加注释。

2.在Class.cs 文件中添加如下代码。

/*************************************************************************************
 *
 * 文 件 名:   $safeitemname$
 * 描    述: 
 * 
 * 版    本：  V1.0
 * 创 建 者：  $username$ 
 * 创建时间：  $time$
 * ======================================
 * 历史更新记录
 * 版本：V          修改时间：         修改人：
 * 修改内容：
 * ======================================
*************************************************************************************/

$safeitemname$、$rootnamespace$ 这些参数都是系统变量，功能类似于Foxmail模版里面的宏。

其他可用的参数有：（需要注意：这些参数区分大小写！）

3.这样在新建c#类文件时就会自动添加注释说明信息了。

二、使用VS的扩展插件

License Header Manager许可证头管理器允许你：

定义每个 Visual Studio 项目和每个文件扩展名的许可头
通过add添加为链接可在项目之间共享许可头
添加，删除和替换一个或者全部文件的标题
将你的许可证头放在 #regions 中
像%FileName%, %Project% or %UserName% 等使用使用扩展特性，并且在每次重新插入标题时自动填充

源代码网址:http://www.github.com/rubicon-oss/LicenseHeaderManager
文档：https://github.com/rubicon-oss/LicenseHeaderManager/wiki

1、安装License Header Manager扩展，将许可证标头添加到项目中。

在VS2013以上的扩展菜单中，搜索添加此插件进行安装。

2、设置：

注意：勾选在新建文件时自动插入文件头部。取消勾选“至少有如下的一个关键字时才可以移除头部”。

设置默认头部，以C#为例，编辑如下的代码到下面所示文本框中。

extensions: .cs
/*************************************************************************************
 *
 * 文 件 名:   %FileName%
 * 描    述: 
 * 
 * 版    本：  V1.0
 * 创 建 者：  %UserName%
 * 创建时间：  %CreationYear%/%CreationMonth%/%CreationDay% %CreationTime%
 * ======================================
 * 历史更新记录
 * 版本：V          修改时间：         修改人：
 * 修改内容：
 * ======================================
*************************************************************************************/

默认头部框，点击右下角的编辑按钮进行修改。

可用的扩展属性：

％FullFileName％扩展为完整的文件名（包括目录路径），
％FileName％扩展为文件名，
％CreationYear％，％CreationMonth％，％CreationDay％，％CreationTime％扩展为各自的文件创建DateTime属性（时间为（以短时间格式），
％CurrentYear％，％CurrentMonth％，％CurrentDay％，％CurrentTime％扩展为各自的当前DateTime属性（时间为短时间格式），
％UserName％扩展为当前名称（登录）用户
％Project％扩展到包含项目的名称（从1.4开始）
％Namespace％扩展到文件中使用的第一个命名空间（从1.4开始）
％UserDisplayName％扩展到当前用户的全名（从1.6开始）