头文件注释轻松搞—VS2013

随着学习的不断深入,我们也正在逐步触摸到职业化的门槛,就拿注释来说,良好的注释说明在职业化编程中是非常必要的,因为这有助于他人对程序的阅读理解,使小组之间交流起来更加便利。

这几天在编写重构机房收费系统,里面当然少不了注释,但是我对其中的一种注释却非常的头疼—文件头注释。因为头注释里面的内容多,而且每个类或窗体里面的头注释内容大多相似,所以每次新建一个类或窗体的时候都要复制粘贴(当然还得稍微修改一下)。每次做这些重复的事情让我感到很无奈,所以就想到是不是有种方法可以让VS自动生成头注释呢?在网上一搜索就查询到了很多关于头注释编辑的文章,果然有很多大牛们都想到了这种情况,并且还提供了解决的方法。

在这里给大家做一个详细的说明:

头文件注释的要求:

注释中必须添加的内容有:版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等,头文件的注释中还应有函数功能简要说明。

类头注释的模版:

(仅供参考)

‘**********************************************

‘ 文  件  名:$safeitemname$

‘ 命名空间:$rootnamespace$

‘ 内       容:

‘ 功       能:

‘ 文件关系:

‘ 作       者:XXX

‘ 小       组:XX

‘ 生成日期:$time$

‘ 版  本  号:V1.0.0.0

‘ 修改日志:

‘ 版权说明:

‘**********************************************

如何添加模版:

(以我为例)

    1. 打开VS2013的安装目录  D:\应用软件\Visual Studio 2013

    2. 找到Common7文件夹,接着打开 Common7\IDE\ItemTemplatesCache

    3. 在这里我们会看到VisualBasic文件夹,依次打开 VisualBasic\Code\2052\Class ,找到Class.vb文件并且以记事本方式打开,在其中加入以上的模版保存,如下图:

然后打开VS2013,新建一个类试一下效果:果然,新建类时VS就会自动生成
头文件注释了。

4. 在VisualBasic\Code\2052这个目录下还有Interface
,WebClass
等文件夹,没错修改其中相应的.vb文件,添加上述模版,效果图:接口的头注释已经自动添加。

5.现阶段大家做的系统有很多From窗体,可是在VisualBasic\WindowsForms\2052里并没有From这个文件夹,那么From的注释模版该怎么添加呢?

打开步骤三中的文件夹VisualBasic,找到\VisualBasic\WindowsForms\2052\Form,找到From.vb文件并按照上述方法修改即可。

另外:在D:\应用软件\VisualStudio 2013\Common7\IDE\ItemTemplatesCache目录下不仅仅有VisualBasic,还有CSharp、JavaScript等语言,上述方法同样适用!

$safeitemname$、$rootnamespace$
??

这些参数都是系统变量,功能类似于Foxmail模版里面的宏。

其他可用的参数有:(需要注意:这些参数区分大小写!)

磨刀不误砍柴工,这些积累将来都会是我们提高工作效率的筹码!

头文件注释轻松搞—VS2013,布布扣,bubuko.com

时间: 2024-10-26 00:29:29

头文件注释轻松搞—VS2013的相关文章

eclipse头文件注释

在编写Java文件时,为便于后来者阅读经常会编写注释,其中头文件注释属于规范性的注释,可以使用eclipse的设置统一管理,下面就将自己编写的操作过程写下: 1.打开eclipse 2.点击Windows选择preferences选项,如图: 3.展开Java->展开code style->点击code templates->展开code->点击new Java files -> 点击右边的edit,如图 4.在弹出框内编写规范,写好之后一直点ok,最后可以new class

Vs2013 头文件注释

在vs2013的默认安装目录 1.CS类修改方式 在C:\Program Files (x86)\Microsoft Visual Studio 12.0\Common7\IDE\ItemTemplatesCache\CSharp\Code\2052\Class下 修改Class.cs类在全上方加上 /*************************************************************文 件 名:$safeitemname$ **命名空间:$rootname

c++文件\函数\头文件注释格式

/******************************************************************* *  Copyright(c) 2000-2013 Company Name *  All rights reserved. * *  文件名称: *  简要描述: * *  创建日期: *  作者: *  说明: * *  修改日期: *  作者: *  说明: ************************************************

Source Insight里头文件注释和函数头的注释

1.将下述代码拷贝入一个文件,扩展名为em 2.打开BASE工程,添加本文件,并重新同步 3.添加hh_InsertFuncHeader的快捷键,即为函数头注释,光标需要放在函数名那一行,否则无效 4.添加hh_InsertFileHeader的快捷键,即为文件头注释,且头文件(目前只是.h)和源文件(非.h文件)不同,头文件里有 macro hh_InsertFuncHeader(){hbuf = GetCurrentBuf()szFunc = GetCurSymbol()if (strlen

UINavigationBar的translucent属性在头文件中注释的翻译

先吐槽一下,apple的注释写得挺绕的,一大堆的后置定语. translucent iOS7下具有新的行为. 你可以通过设置这个属性为NO,强制背景为不透明. 如果导航栏的背景图为自定义,其默认值将从背景图的alpha值推断而来, 背景图只要有一个像素的alpha值<1.0,则translucent的值推断为YES. 如果设置translucent为YES,而自定义背景图不透明. 则会给图片加上一个小于1.0的系统预定义的透明度. 如果translucent置为NO,而自定义的背景图为半透明,

批量替换程序的文件注释头

Install: Just unpack the files into your home directory. It will create a directory ~/rh containing all files. Now edit the file ~/rf/header.template to fit your needs. That's it. Usage: ~/rh/replace_header.sh <file> This replaces only the header of

怎么把PDF文件转换成Word?三招教你轻松搞定

PDF和Word两个文件之间,相互转换是在我们的工作中经常需要用到的,也曾经是很多职场新人的困扰,很多人都想知道怎么把PDF文件转换成Word?今天呢就来给大家分享三个简单的方法,只需三招就能轻松搞定. 方法1:打开方式为Word 怎么把PDF文件转换成Word?这个方法其实很简单的,只需要点击PDF文档,选择打开方式为Word,利用Word打开即可.步骤:点击PDF文件--右击鼠标--选择[打开方式]--点击Word:方法2:专业转换器 如果在觉得通过Word打开方式不太好用的话,可以使用专业

linux下C/C++头文件梳理,看完这篇再也不会搞糊涂头文件了!

一:前言 进行linux下C/C++服务端后台开发的都知道,需要跟各种头文件打交道. 比如使用printf函数则需要引用#include <stdio.h>,使用STL的map容器则要#include <map>,使用socket网络编程则要#include <sys/socket.h>, 那么我考考你uint32_t是在哪个头文件定义的呢?sleep函数又是在哪个头文件?open和close是在同一个头文件里吗? 是不是有点一时半会答不上来,有没有好的方法能梳理头文件

VS2013如何添加LIb库及头文件的步骤

在VS工程中,添加c/c++工程中外部头文件及库的基本步骤: 1.添加工程的头文件目录:工程---属性---配置属性---c/c++---常规---附加包含目录:加上头文件存放目录. 2.添加文件引用的lib静态库路径:工程---属性---配置属性---链接器---常规---附加库目录:加上lib文件存放目录.         然后添加工程引用的lib文件名:工程---属性---配置属性---链接器---输入---附加依赖项:加上lib文件名. 3.添加工程引用的dll动态库:把引用的dll放到