本文将讲解C程序注释模板的使用背景、创建方法,并在结束时进行总结。

1、使用背景

  在项目开发过程中,为方便组内其他成员能够快速学习自己编写的代码,需要对自己写的函数添加注释。在正规的软件开发流程中,一个标准的函数及其注释可能如下所示。

/************************************************************************
Function: ParseBinFile Description: 解析Bin文件数据 Parameter: binFileNameLen --[in] bin文件名长度
binFileName --[in] bin文件名
resultDataLen --[out] 目标数据长度
resultData --[out] 目标数据 Return: 0, 执行成功
非0, 执行失败 ************************************************************************/
int ParseBinFile(int binFileNameLen,char *binFileName,int resultDataLen, char *resultData)
{
return ;
}

  如果在项目中需要推广函数+注释这种编程规范,那么最笨最简单的方法是:手写一个通用的注释段,然后依次进行copy,但是这种方法需要大量的手动操作,既低效又易出错。

  如果使用的是Java语言,那么可以采用现成的Javadoc工具,为每一个类、方法添加注释模板,其格式如下所示:

  

/**   

* The doGet method of the servlet.   

* This method is called when a form has its tag value method equals to get.   

*   

* @param request   

* the request send by the client to the server   

* @param response   

* the response send by the server to the client   

* @throws ServletException   

* if an error occurred   

* @throws IOException   

* if an error occurred   

*/     

public   void  doGet (HttpServletRequest request, HttpServletResponse response)    

throws  ServletException, IOException {    

doPost(request, response);    

}    

  Visual C++6.0中不具备像Javadoc这样注释自动生成工具,那么只能依靠插件Visual AssistantX进行辅助。

2、创建方法

  2.1、在Visual C++6.0中安装Visual Assistant X;

  a、找到破解版Visual Assitant X(一个小的软件下载网站),笔者用的版本是V10.0.1233.0;

  b、直接点击Setup目录下的VA_X_Setup1230.exe进行安装;

  c、将CR目录下的文件拷贝至安装路径,双击VA_X.reg,进行注册表注册;

  2.2、编写注释模板;

  a、打开Visual Assistant X的工具栏,点击Visual Assistant X Option,选择“Autotext/Templates”

  

  b、在右侧页面中添加注释模板。注意:代码中FF是模板结束标志,等同于上图中FF

/*+:
/************************************************************************
Function: Description: Parameter: --[in]
--[out]
--[in/out] Return: 0, SUCCESS
Other, FAILURE Note: Others: Attention:
************************************************************************/FF

  2.3、实例应用;

  在VC++6.0中打开一个C源文件,敲击/*+,即可自动生成注释:

3、总结

  充分利用Visual Assistant 中的模板功能,可以拓展VC++6.0的功能,让代码编写更加简单、快捷。

使用Visual Assistant X创建C程序注释模板的更多相关文章

  1. 使用Visual Studio扩展插件Visual assist X给代码插入注释模板

    Visual Assist 是由Whole Tomato公司为Microsoft Visual Studio开发的一款插件.它对Visual Studio的智能提示功能和代码高亮功能进行了增强,同时还 ...

  2. visual studio扩展插件Visual Assist x给代码插入注释模板(转载)

    转载:http://www.cnblogs.com/xiongmao-cpp/p/5196555.html Visual Assist 是由Whole Tomato公司为Microsoft Visua ...

  3. idea设置创建类的注释模板

    打开settings>>Editor>>File and Code Templates>>Includes>>File Header

  4. windows屏幕保护程序opengl模板

    Visual Studio 2013 屏幕保护程序opengl模板 ScreenSaver.cpp #define VC_EXTRALEAN #include <windows.h> #i ...

  5. IDEA中设置注释模板的方法

    IDEA中设置注释模板主要分为两个部分,分别是创建java文件时类的注释和方法的注释. 这里为大家详细介绍一下方法,按MyEclipse的风格设置(MyEclipse的请看:MyEclipse中设置注 ...

  6. IDEA 注释模板配置

    配置创建类的注释模板 Ctrl + Shift + a --> File and Code Templates // 快捷定位配置 // 路径:File --> Settings --&g ...

  7. Visual Studio中创建混合移动应用程序解决方案Xamarin Portable Razor

    在Visual Studio中创建混合移动应用程序的一个解决方案是使用Xamarin Portable Razor工具,这是ASP.NET MVC API针对移动设备的一个轻量级实现.Xamarin编 ...

  8. 使用Visual Studio 2010 创建简单的Silverlight应用程序

    使用Visual Studio 2010 创建简单的Silverlight应用程序 Silverlight是创建动态的引人的RIAs(Rich Internet Application)的新方法.这里 ...

  9. 使用Visual Studio 2008创建你的第一个Windows Mobile程序介绍

    使用Visual Studio 2008创建你的第一个Windows Mobile程序介绍 Windows MobileMobileWindowsMicrosoftWinForm 介绍 Microso ...

随机推荐

  1. 因特网服务的类型(协议),目前最流行的类型是 http协议

    在学习超链接中,在HTML上点击QQ图标时会 自动的启动自己本地QQ客户端,其方法是使用了超链协议 一些常用协议如下: file资源是本地计算机上的文件.格式file:/// ftp通过 FTP访问资 ...

  2. 数据获取以及处理Beta版本展示

    产品描述 这个产品的目的是为了学霸网站提供后台数据获取以及处理操作.在alpha阶段基本调通的基础至上,我们希望在bate版本中加入对于问答对的处理,图片的获取等功能. 预期目标 在alpha阶段,我 ...

  3. 编译c

    1.打开vs工具 2.弄到相同路径(同所编译文件) 3.cl(微软编译器) 生成 obj exe文件 4.system是一个通用指令 可以在windows linux mac用

  4. python 3 学习笔记 (三)

    1. 字典 定义:{key1:value1,key2:value2},key-value结构,key必须可hash特性:1.可存放多个值2.可修改指定key对应的值,可变3.无序 1.1. 创建字典 ...

  5. MVC授权

    public class CommonController : Controller { protected override void OnAuthorization(AuthorizationCo ...

  6. 《Matrix Computation 3rd》读书笔记——第4章 特殊线性系统

  7. android development

    1. Supporting different devices 1) Supporting different screen size 主要有几点,首先是布局文件夹以及布局文件的命名 layout/m ...

  8. Lua简介

    Lua是一种扩展语言,脚本语言,还没有主程序的概念,类似于插件,也即不能直接使用,必须嵌入在牛逼的语言里使用,如Python. Lua由C语言编写,可以在宿主语言里写一段c程序,让Lua的解释器使用, ...

  9. Python——面向对象

    一.创建类 语法格式: class 类名: pass 创建方法: 1 构造方法 class Person: def __init__(self, name,age): #构造方法,构造方法的特性, 类 ...

  10. Google副总裁的管理经验

    一.拥挤其实是创新.拥挤喧闹的工作环境会引燃更多的创意火花.办公室应该充满能量和互动,而不是条块分割和等级分化. 二.战略和策略并举.许多人不懂得战略和策略的区别,或者他们认为自己只需要其中一样,其实 ...