C# 在类文件自动添加文件注释的方法

最新推荐文章于 2024-01-31 10:52:57 发布

weixin_34191734

最新推荐文章于 2024-01-31 10:52:57 发布

阅读量629

点赞数

CC 4.0 BY-SA版权

文章标签： c#

原文链接：http://www.cnblogs.com/peterYong/p/6556684.html

本文介绍如何在Visual Studio 2013中自定义类模板以自动添加注释信息，包括修改路径及具体操作步骤。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

对于vs2013来讲，

步骤：

1.VS2013 中找到（安装盘符以C盘为例）C:\ProgramFiles(x86)\Microsoft VisualStudio12.0\Common7\IDE\ItemTemplatesCache\CSharp\Code\2052\Class

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

若路径是：

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

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

对于vs2008来讲，路径是C:\Program Files (x86)\Microsoft Visual Studio 9.0\Common7\IDE\ItemTemplatesCache\CSharp\Code\2052\Class.zip

2.在Class.cs 文件最上面添加如下代码。

/*
* ==============================================================================
*
* File name: $safeitemname$
* Description:
*
* Version: 1.0
* Created: $time$
*
* Author: Your name

* Company: Your company name

* Compiler: Visual Studio 2013
* Machine name: $machinename$
* CLR Version: $clrversion$
*
* ==============================================================================
*/

或者：

   /*************************************************************************************
     * CLR版本：       $clrversion$
     * 类名称：       $itemname$
     * 机器名称：       $machinename$
     * 命名空间：       $rootnamespace$
     * 文件名：       $safeitemname$
     * 创建时间：       $time$
     * 作    者： xxx
     * 说明：
     * 修改时间：
     * 修改人：
    *************************************************************************************/

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

我采用的是下面这种：

/*
* ==============================================================================
*
* File name: $safeitemname$
* Description:
*
* Version: 1.0
* Created: $time$
*
* Author: Your name
* Company: Your company name
*
* ==============================================================================
*/