软件编写规范个人总结.docxVIP

软件编写规范个人总结 author:赵文文 date : 2014-11-5 version: v1.0 目录 TOC \o 1-5 \h \z \o Current Document 前言 2 \o Current Document 函数命名规范 2 \o Current Document 接口定义规范 2 \o Current Document 文件命名规范 3 \o Current Document 注释规范 3 前言 在最近维护加油站的事情当中， 碰到很多问题，其中最苦恼的一个问题就是被各种命名 方式不统一的文件、 函数等等误导的，以至于对一些程序的功能理解的偏差。于此同时，回 顾自己以往所写的一些代码，由于命名不规范，竟然现在对自己写的代码不能一看就明白， 而且由于没有将输入与函数功能独立出来， 导致代码的重复率很高。 基于以上这些问题， 所 以有必要花些时间在最基本的问题上。 函数命名规范 函数命名上，现在比较主流的有骆驼（ Camel）命名法、帕斯卡（PascaD命名法、以及 c中常用的下划线命名法。命名的方式由很多种，挑选一种自己喜欢的，遵守规范即可，写 出属于自己的风格。 我自己比较喜欢骆驼命名法， 所谓骆驼命名法：即函数第一个单词首字母小写， 之后每 个单词首字母大写，如下： inputCheck（）:即输入检查 printErrorReason（）:打印错误信息 这样的命名方式可以很容易让看代码人知道函数的功能。 函数名写长一些没关系但一定要遵 守规范。如果代码只是对特定的人员看，我们对一些函数的命令可以做一些缩写，如下： readRealGunInfo（）:读取真实灌枪信息 接口定义规范 接口是指将定义（规范，约束）与实现（名实分离的原则）的分离。个人喜欢讲接口分 为两类，一类是对内的接口，一类是对外的接口。 对内的接口，是指系统内部相互调用需要使用的接口， 对整接口的约束比较弱， 没必 要使用严格的数据格式要求，仅供内部使用，只需要对参数名称按规范命名即可。 对外的接口，是指供系统外部的使用的接口， 使用接口的人不需要知道系统具体的实现, 只要提供正确的输入，就可以获得正确的输出。目前比较流行的是使用 json格式的输入输 出，所以在定义外部接口时， 我们也应该想尽办法是自己的输入与输出为 json格式。同时， 也应该对外部接口有相应的说明文档。如下： 接口名称：login input: { username : string , password: string } output : { result:int reason:string; 个别参数说明：result: 0成功 1失败 reason :失败时原因 如上所示，将输入与输出严格的定义为json格式，对个别一些特殊参数进行说明。这 如上所示，将输入与输出严格的定义为 里可以参照一下 新浪API说明文档，/wiki/ 微博API。 c语言中使用json库时需要加载的json库下载地址: http://www.linuxpig.eom/softwares/mjson/mjson-0.9.tar.bz2 使用时只需要在添加 #include json.h即可调用其内部的函数。这里是一个样例，可参 昭? 八、、? /bbs/view/1319816469499 json 官网： / 文件命名规范 文件是属于同一功能模块的子模块(函数、数据类型)的集合，所以文件的名字应该能 够清晰反映该模块的功能。方式与函数的命名比较类似。 注释规范 一个良好的程序员要有良好的编程习惯， 而一个良好的编程习惯离不开规范的注释。 在 代码编写中，注释要占代码总量的 ％15。以下是一些注释的基本规范。 文件开头必要的注释，格式如下 /* *fileName: ---文件名 *revision: ---版本号 *description: ---文件描述 */ 函数开头注释，格式如下 /* @fn ---函数名 @brief ---描述 @param ---参数说明 @return ---返回值说明 */ 函数内部注释，函数内部注释主要使用//的注释，主要是对一些比较难懂的地方做 一些必要的说明。写在开始的地方。如下 //初始化设备安全设置 ZDSecMgrlnit(state); 办公室卫生管理制度 一、 主要内容与适用范围 1 .本制度规定了办公室卫生管理的工作内容和要求及检查与考核。 2.此管理制度适用于本公司所有办公室卫生的管理 二、 定义 1-公共区域：包括办公室走道、会议室、卫生间，每天由行政文员进行清扫； 2.个人区域：包括个人办公桌及办公区域由各部门工作人员每天自行清扫。 公共区域环境卫生应做到以下几点： 保持公共区域及个人