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

    一个优秀的程序员,良好的编程习惯是必须具备的。而我们在进行软件开发的过程中,给代码添加注释是我们必不可少的。但是在添加注释的过程中有很多注释都是重复的,比如我们类模块的头注释几乎都是重复的。我们很多人还在Ctrl+C,Ctrl+V,不断的重复,不断的浪费时间。在我们这个飞速发展的信息时代,时间就是一切,所以凡事我们都要讲究高效,而不是以无休止的的消耗时间为代价。在这个时代没有你做不到的,只有你想不到的。在这里对于给类模块添加头注释,我们除了Ctrl+C,Ctrl+V之外,其实我们还有更高效,更自能的办法。其实这个办法,微软早给我们解决了,只是我们这些菜鸟还不知道而已。说到这里要赞扬一下微软,关于“全心全意为人民服务”的思想,微软做的很好。在我们这个社会,只有你做到了“全心全意为人民服务”,老百姓才乐于买你的单。这个社会是一个讲究合作的社会,所以我们要做到“双赢”。其实,这不仅仅是为人民服务,更是为我们自己服务,也是21世纪的生存之道。废话不说了,我们来进入正题。


   在类模块中添加头注释的时候,很多菜鸟都是不断的重复着Ctrl+C,Ctrl+V 。其实我们除了这种笨办法,我们还有更自能的办法。只需要你稍微动动鼠标,我们就能很轻松的解决这个问题了,并且让你一劳永逸。下面让我们来看看具体要怎么做。在VS 这个IDE的安装路径下有一个IDE设置模板文件夹,我们只要稍稍修改一下里面的文件就可以搞定。


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

 

    在这个时代没有你做不到的,只有你想不到的。那里有需求,那里就有市场。全心全意为人民服务,是21世纪的生存之道。

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

上一篇:uva 297 Quadtrees


下一篇:小数学解决大问题 - 布隆过滤器 Bloom Filter(由数字进制想到)