当前位置:编程学习 > ASP.NET> 正文

Visual Studio 自动添加头部注释

时间:2016-6-2类别:编程学习

Visual Studio 自动添加头部注释

Visual Studio 自动添加头部注释

一、下面以 为类文件添加头部注释 为例介绍

1、找到VS的安装目录,依次找到Common7\IDE\ItemTemplatesCache

注意是ItemTemplatesCache而不是ItemTemplates,虽然两个目录都可以但是ItemTemplates目录下的文件一旦修改就不能还原了

2、ItemTemplatesCache文件夹下有多个文件,分别表示不同语言的模板,根据需要添加注释的文件类别进行修改。例如修改CSharp文件夹下面的模板

3、CSharp文件夹下包含不同的项目模板,由于要修改C#类文件,进入Code文件夹

4、进入上述文件夹,下面包含类文件夹、接口文件夹等,我们选择 Class文件夹

5、打开上图中的 Class.cs 文件,进行修改

  •  
  • 
    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$
    {
        class $safeitemrootname$
        {
        }
    }
    
    		
  • 6、添加注释后的模板文件

  •  
  • C# 代码   复制
  • 
    // =============================================================================== 
    // Author              :    学习也休闲
    // WEBSITE             :    http://www.studyofnet.com
    // Create Time         :    $time$
    // Update Time         :    $time$
    // =============================================================================== 
    // CLR Version         :    $clrversion$
    // Class Version       :    v1.0.0.0
    // Class Description   :    
    // ===============================================================================
    // Copyright ©学习也休闲 $year$ . All rights reserved.
    // ===============================================================================
    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$
    {
        class $safeitemrootname$
        {
        }
    }
    
    		
  • 7、保存,在 Visual Studio 中添加一个类文件,出现如下效果,自动添加头部注释成功

  •  
  •  
  •  
  • C# 代码   复制
  • 
    //===============================================================================
    // Author              :    学习也休闲
    // WEBSITE             :    http://www.studyofnet.com
    // Create Time         :    2012/3/29 13:38:53
    // Update Time         :    2012/3/29 13:38:53
    //===============================================================================
    // CLR Version         :    4.0.30319.18444
    // Class Version       :    v1.0.0.0
    // Class Description   :    
    //===============================================================================
    // Copyright ©学习也休闲 2016. All rights reserved.
    //===============================================================================
    using System;
    using System.Collections.Generic;
    
    using System.Linq;
    using System.Text;
    using System.Threading.Tasks;
    
    namespace StudyOfNet
    {
        public partial class Study: System.Web.UI.Page
        {
            protected void Page_Load(object sender, EventArgs e)
            {
    
            }
        }
    }
    
    				
  • 二、比较常用的模板配置变量

  •  
  •  
  • 
    $time$     日期
    
    $year$     年份
    
    $clrversion$    CLR版本
    
    $GUID$   用于替换项目文件中的项目 GUID 的 GUID。最多可以指定 10 个唯一的 GUID(例如,guid1))。
    
    $itemname$  用户在对话框中提供的名称。
    
    $machinename$    当前的计算机名称(例如,Computer01)。
    
    $projectname$   用户在对话框中提供的名称。
    
    $registeredorganization$   HKLM\Software\Microsoft\Windows NT\CurrentVersion\RegisteredOrganization 中的注册表项值。
    
    $rootnamespace$  当前项目的根命名空间。此参数用于替换正向项目中添加的项中的命名空间。
    
    $safeitemname$  用户在“添加新项”对话框中提供的名称,名称中移除了所有不安全的字符和空格。
    
    $safeprojectname$  用户在“新建项目”对话框中提供的名称,名称中移除了所有不安全的字符和空格。
    
    $time$    以 DD/MM/YYYY 00:00:00 格式表示的当前时间。
    
    $userdomain$  当前的用户域。
    
    $username$  当前的用户名。
    
    		
  • 标签:
    上一篇下一篇

    猜您喜欢

    热门推荐