使用Visual Assistant X创建C程序注释模板
本文将讲解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程序注释模板的更多相关文章
- 使用Visual Studio扩展插件Visual assist X给代码插入注释模板
Visual Assist 是由Whole Tomato公司为Microsoft Visual Studio开发的一款插件.它对Visual Studio的智能提示功能和代码高亮功能进行了增强,同时还 ...
- visual studio扩展插件Visual Assist x给代码插入注释模板(转载)
转载:http://www.cnblogs.com/xiongmao-cpp/p/5196555.html Visual Assist 是由Whole Tomato公司为Microsoft Visua ...
- idea设置创建类的注释模板
打开settings>>Editor>>File and Code Templates>>Includes>>File Header
- windows屏幕保护程序opengl模板
Visual Studio 2013 屏幕保护程序opengl模板 ScreenSaver.cpp #define VC_EXTRALEAN #include <windows.h> #i ...
- IDEA中设置注释模板的方法
IDEA中设置注释模板主要分为两个部分,分别是创建java文件时类的注释和方法的注释. 这里为大家详细介绍一下方法,按MyEclipse的风格设置(MyEclipse的请看:MyEclipse中设置注 ...
- IDEA 注释模板配置
配置创建类的注释模板 Ctrl + Shift + a --> File and Code Templates // 快捷定位配置 // 路径:File --> Settings --&g ...
- Visual Studio中创建混合移动应用程序解决方案Xamarin Portable Razor
在Visual Studio中创建混合移动应用程序的一个解决方案是使用Xamarin Portable Razor工具,这是ASP.NET MVC API针对移动设备的一个轻量级实现.Xamarin编 ...
- 使用Visual Studio 2010 创建简单的Silverlight应用程序
使用Visual Studio 2010 创建简单的Silverlight应用程序 Silverlight是创建动态的引人的RIAs(Rich Internet Application)的新方法.这里 ...
- 使用Visual Studio 2008创建你的第一个Windows Mobile程序介绍
使用Visual Studio 2008创建你的第一个Windows Mobile程序介绍 Windows MobileMobileWindowsMicrosoftWinForm 介绍 Microso ...
随机推荐
- ios系统(苹果手机)按钮显示为圆角和渐变的问题
按钮在安卓手机上显示正常,但在苹果手机上会显示如下: 解决办法:给该按钮的样式加上:-webkit-appearance:none;这样按钮就会显示正常
- React 学习笔记(学习地址汇总)
好的博文地址:http://www.ruanyifeng.com/blog/2015/03/react.html 官网学习地址:http://facebook.github.io/react/docs ...
- 带日期的bean转为json(bean->JSON)
示例代码: JsonBean bean = new JsonBean();bean.setName("NewBaby");bean.setAge(1);bean.setBorn(n ...
- HTML 兼容性
1. 不同浏览器对HTML标记所具有的内外边距属性具有不同的定义. 2. 因此如果想消除这种差距,应该在相应的CSS部分加入以下CSS代码: *{margin:0px;padding:0px;} 优先 ...
- nodejs--模块
在客户端可以将所有的javascript代码分割成几个JS文件,然后在浏览器中将这些JS文件合并.但是在nodejs中是通过以模块为单位来划分所有功能的.每一个模块为一个JS文件,每一个模块中定义的全 ...
- Android Sqlite数据库加密
Android使用的是开源的SQLite数据库,数据库本身没有加密,加密思路通常有两个: 1. 对几个关键的字段使用加密算法,再存入数据库 2. 对整个数据库进行加密 SQLite数据库加密工具: 收 ...
- CE 定时器
//头文件: afx_msg void OnTimer(UINT_PTR nIDEvent); //声明定时器响应函数 //代码文件: #define TIMER 1 #define TIMEROUT ...
- SQL Server系统存储过程
1. execute sp_databases 查询当前所有数据库大致信息(名称,大小等) 2. exec sp_helpdb [Myschool] 返回数据库的所有详细信息(数据库大小,位置,文 ...
- 第一个Struts2程序之HelloWorld
1.Struts2 简介 Struts 2是Struts的下一代产品,是在 struts 1和WebWork的技术基础上进行了合并的全新的Struts 2框架.其全新的Struts 2的体系结构与St ...
- linux memory
http://duartes.org/gustavo/blog/post/how-the-kernel-manages-your-memory/ http://duartes.org/gustavo/ ...