让VS自动生成我们自己的注释

本文详细介绍了如何在Visual Studio中自定义类头注释模板,包括设置注释格式、填写必要信息及保存文件等步骤,帮助企业开发者实现标准化注释,提升代码质量和维护效率。

1. 找到你VS的安装目录:C:\Program Files (x86)\Microsoft Visual Studio 11.0


2. 在VS安装路径下依次找到这些文件夹:\Common7\IDE\ItemTemplatesCache


3.  根据你具体使用的编程语言来修改下面具体的文件夹


A. 如果你是VisualBasic语言,那你就接着找到\VisualBasic\Code\2052\Class文件夹下的Class.vb文件打开(如 果是C#语言,则找到CSharp\Code\2052\Class文件夹下的Class.cs文件打开,其他语言也是同样的方法。其实,在这里还可以设 置其他注释模板,比如Interface,窗体等,只需找到相应的文件在里面加上你想要的注释就OK了)


B. 在文件开头加上你想要的类头注释,比如


'**********************************************

'说明:

'计算机名称:$machinename$

'创建日期:$time$

'作者:戈录普

'版本号:V1.00

'**********************************************

PublicClass $safeitemname$

 

EndClass

  

C. 保存文件,关闭


   做到这里一切就OK了,其实就是这样简单。以后只要你新建类,就会出现你想要的类头注释了。比如:


'**********************************************

'说明:

'计算机名称:GELUPU-PC

'创建日期:2014/1/2321:34:46

'作者:戈录普

'版本号:V1.00

'**********************************************

PublicClassClass1

 

EndClass

 

   这是企业里正规开发的常用注释。


/************************************************************************************

 * Copyright (c) $year$$registeredorganization$ All Rights Reserved.

 * CLR版本: $clrversion$

 *机器名称:$machinename$

 *公司名称:$registeredorganization$

 *命名空间:$rootnamespace$

 *文件名:  $safeitemname$

 *版本号:  V1.0.0.0

 *唯一标识:$guid10$

 *当前的用户域:$userdomain$

 *创建人:  $username$

 *电子邮箱:XXXX@sina.cn

 *创建时间:$time$

 *描述:

 *

 *=====================================================================

 *修改标记

 *修改时间:$time$

 *修改人: $username$

 *版本号: V1.0.0.0

 *描述:

 *

/************************************************************************************/

 

下面我们再来简单的解释下注释模板代码里的参数。

 

 

参数

描述

clrversion

当前系统CLR版本号

GUID [1-10]

生成全局唯一标识符,可以生成10个 (例如:guid1)

itemname

打开添加新建项时输入的文件名称

machinename

当前机器的名称(如:XXXX)

registeredorganization

注册的组织名

rootnamespace

命名空间名

safeitemname

保存的文件名

time

当前系统时间,格式:DD/MM/YYYY 00:00:00.

userdomain

用户所在的域

username

当前系统用户名

year

当前系统时间 YYYY

转载于:https://www.cnblogs.com/jaday/p/3597579.html

评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符  | 博主筛选后可见
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值