软件编写规范个人总结
author：赵文文
date：2014-11-5
version：v1.0
目录
前言........................................................................................................................................... 2
函数命名规范 ........................................................................................................................... 2
接口定义规范 ........................................................................................................................... 2
文件命名规范 ........................................................................................................................... 3
注释规范 ................................................................................................................................... 3
前言
在最近维护加油站的事情当中，碰到很多问题，其中最苦恼的一个问题就是被各种命名方式不统一的文件、函数等等误导的，以至于对一些程序的功能理解的偏差。于此同时，回顾自己以往所写的一些代码，由于命名不规范，竟然现在对自己写的代码不能一看就明白，而且由于没有将输入与函数功能独立出来，导致代码的重复率很高。基于以上这些问题，所以有必要花些时间在最基本的问题上。
函数命名规范
函数命名上，现在比较主流的有骆驼（Camel）命名法、帕斯卡（Pascal）命名法、以及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库下载地址：
使用时只需要在添加 #include <json.h>即可调用其内部的函数。这里是一个样例，可参照：
json官网：
文件命名规范
文件是属于同一功能模块的子模块（函数、数据类型）的集合，所以文件的名字应该能够清晰反映该模块的功能。方式与函数的命名比较类似。
注释规范
一个良好的程序员要有良好的编程习惯，而一个良好的编程习惯离不开规范的注释。在代码编写中，注释要占代码总量的%15。以下是一些注释的基本规范。
1. 文件开头必要的注释，格式如下
/*
*fileName: ---文件名
*revision: ---版本号
*description: ---文件描述
*/
2. 函数开头注释，格式如下
/*
* @fn ---函数名
* @brief ---描述
* @param ---参数说明
* @return ---返回值说明
*/
3. 函数内部注释，函数内部注释主要使用//的注释，主要是对一些比较难懂的地方做一些必要的说明。写在开始的地方。如下
// 初始化设备安全设置
ZDSecMgrInit(state);
第二篇：调查报告及个人总结规范及要求
附件1：
调查报告的撰写规范及要求
一、内容要求
调查报告的写作一般包含选题的目的及意义（前言）、调查经过与内容（主体）、结语三个部分。
第一部分，对选题意义、调查对象、方法的介绍。介绍选题是要表明你的文章是有现实意义、有价值的；介绍调查对象和调查方法，是要表明你使用的方法是科学的，文中的材料是真实可靠的。这部分内容在文章开头，要求简明概括。
第二部分，可根据调查的性质和材料决定不同的写法。例如事件调查常常根据事件的发展过程来写，从事件的产生、发展经过、结果与影响，到处理这一事件的方法与建议。而经验调查往往省略过程描述，只根据调查所得的基本经验逐条叙述。另外，也可以根据调查所得的基本结论，从多方面举例加以说明。总之，这一部分要充分反映调查的收获。最好能用简单的统计方法对材料进行量化处理，能用统计图表显示的要尽可能用统计图表显示。
第三部分，对调查材料进行分析，提出自己的思考或意见、建议。既可以边安排材料边进行分析（夹叙夹议）；也可以先安排材料后集中进行分析（先叙后议）。
二、格式要求
1.打印用纸均为A4纸，单面打印，左右页边距为2.5 cm，上下页边距为2.2 cm，行距为1.5倍行距，左侧装订。
2.严格按照文本格式规定要求选择字体、字号、行距和页边距。
3.字数要求在3000字以上。
三、评分要求
调查报告由指导教师写出评语并评分。
调查报告格式样板
绥化学院调查报告
（黑体，小三号，左对齐置顶，加黑）
调查报告题目
（题目自拟，黑体，二号，居中，加黑；如有副标题，字体为宋体，四号）
学生姓名 刘昊
学 号 20xx52321
专 业 中文（文秘）
指导教师 吴春生
（宋体，小三号，居中，加黑）
绥 化 学 院
（楷体_GB2312，二号，居中）
调查报告题目
（题目自拟，黑体，小二号，居中，加黑；如有副标题，字体为宋体，四号）
系别：文学与传媒学院年级：20xx 级 专业：文秘
姓名：刘昊 学号：20xx52321
（学生信息分两行，宋体，小四号，居中，加黑）
前 言
（黑体，四号，居中，加黑）
（前言内容，宋体，小四号，首行空两格）
（主体正文内容，宋体，小四号，首行空两格；如有标题层次，请按以下格式） 一、……（一级标题，宋体，小四号，加黑，首行空两格）
（正文内容，宋体，小四号，首行空两格）
1.……（二级标题，宋体，小四号，空两格）
（正文内容，宋体，小四号，首行空两格）
（1）……（三级标题，宋体，小四号，空两格）
（正文内容，宋体，小四号，首行空两格）
结 语
（黑体，四号，居中，加黑）
（结语内容，宋体，小四号，首行空两格）
年月日
（署上时间，右下角，宋体，小四号）
指导教师评语：
评分： 指导教师签字：年月日
附件2：个人总结格式
5.实习总结1份：1500字以上，A4纸单面打印，左右页边距为2.5 cm，上下页边距为2.2cm；字体宋体，标题字号三号加粗，正文小四号字，行距为1.5倍行距，落款标明院（系）、姓名。