博客
关于我
强烈建议你试试无所不能的chatGPT,快点击我
使用Visual Assistant X创建C程序注释模板
阅读量:6402 次
发布时间:2019-06-23

本文共 2466 字,大约阅读时间需要 8 分钟。

  本文将讲解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 0;}
View Code

  如果在项目中需要推广函数+注释这种编程规范,那么最笨最简单的方法是:手写一个通用的注释段,然后依次进行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);      }
View Code

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

2、创建方法

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

  a、找到破解版(一个小的软件下载网站),笔者用的版本是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
View Code

 

  2.3、实例应用;

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

3、总结

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

 

转载于:https://www.cnblogs.com/fkpj/p/4513175.html

你可能感兴趣的文章
C语言杂谈——与字符串相关的库函数
查看>>
孩子初三上半学期期中考试情况
查看>>
Mono 3 的默认Gc是Sgen
查看>>
业务架构师的服务(靠什么赚钱),从事这一职业需要什么知识?
查看>>
《Springboot极简教程》 Springboot plus Kotlin :Hello,World
查看>>
bboss es对比直接使用es客户端的优势
查看>>
将单个文件上传到多机器工具
查看>>
第17章 KOTLIN语言生态《Kotin 编程思想·实战》
查看>>
LeetCode 191 Number of 1 Bits(1 比特的数字们)
查看>>
RabbitMQ系列(六)你不知道的RabbitMQ集群架构全解
查看>>
springboot统一表单数据校验
查看>>
使用bat将优盘中的dig加到系统环境变量
查看>>
Rust 语言学习笔记(四)—— I/O
查看>>
Java实现流控-Semaphore
查看>>
题解 CF948A 【Protect Sheep】
查看>>
打破软件自动化测试的格局
查看>>
Google 开源新型强化学习框架 Dopamine
查看>>
TreeSet集合的add()方法的源码解析
查看>>
从闭包函数的变量自增的角度 - 解析js垃圾回收机制
查看>>
React+GraphQL入门
查看>>