《软件编写规范个人总结》由会员分享，可在线阅读，更多相关《软件编写规范个人总结（3页珍藏版）》请在金锄头文库上搜索。
1、软件编写规范个人总结author：赵文文date：2014-11-5version：v1.0目录前言1函数命名规范1接口定义规范1文件命名规范2注释规范2前言在最近维护加油站的事情当中，碰到很多问题，其中最苦恼的一个问题就是被各种命名方式不统一的文件、函数等等误导的，以至于对一些程序的功能理解的偏差。于此同时，回顾自己以往所写的一些代码，由于命名不规范，竟然现在对自己写的代码不能一看就明白，而且由于没有将输入与函数功能独立出来，导致代码的重复率很高。基于以上这些问题，所以有必要花些时间在最基本的问题上。函数命名规范函数命名上，现在比较主流的有骆驼（Camel）命名法、帕斯卡（Pascal）命名
2、法、以及c中常用的下划线命名法。命名的方式由很多种，挑选一种自己喜欢的，遵守规范即可，写出属于自己的风格。我自己比较喜欢骆驼命名法，所谓骆驼命名法：即函数第一个单词首字母小写，之后每个单词首字母大写，如下：inputCheck():即输入检查printErrorReason():打印错误信息这样的命名方式可以很容易让看代码人知道函数的功能。函数名写长一些没关系但一定要遵守规范。如果代码只是对特定的人员看，我们对一些函数的命令可以做一些缩写，如下：readRealGunInfo():读取真实灌枪信息接口定义规范接口是指将定义（规范，约束）与实现（名实分离的原则）的分离。个人喜欢讲接口分为两类，一
3、类是对内的接口，一类是对外的接口。对内的接口，是指系统内部相互调用需要使用的接口，对这类接口的约束比较弱，没必要使用严格的数据格式要求，仅供内部使用，只需要对参数名称按规范命名即可。对外的接口，是指供系统外部的使用的接口，使用接口的人不需要知道系统具体的实现，只要提供正确的输入，就可以获得正确的输出。目前比较流行的是使用json格式的输入输出，所以在定义外部接口时，我们也应该想尽办法是自己的输入与输出为json格式。同时，也应该对外部接口有相应的说明文档。如下：接口名称：logininput：username : string ,password: stringoutput：result:in
4、t reason:string;个别参数说明：result：0 成功 1 失败 reason：失败时原因如上所示，将输入与输出严格的定义为json格式，对个别一些特殊参数进行说明。这里可以参照一下 新浪API说明文档，http:/ #include 即可调用其内部的函数。这里是一个样例，可参照：http:/www.open- 文件开头必要的注释，格式如下/*fileName: -文件名*revision:-版本号*description:-文件描述*/2.函数开头注释，格式如下/* * fn -函数名 * brief -描述 * param -参数说明 * return -返回值说明 */3.函数内部注释，函数内部注释主要使用/的注释，主要是对一些比较难懂的地方做一些必要的说明。写在开始的地方。如下/ 初始化设备安全设置 ZDSecMgrInit(state);
