www.si-tech.com.cn
思特奇版权所有,未经许可不得向外传播
C/C++
语言编码规范
神州数码思特奇信息技术股份有限公司
研究院
目 录
概述
文件体系结构
排版规则
注释规则
变量和结构
函数和过程
可测性要求
程序效率
质量保证
安全规则
概述
•
规范本身应该是个规定,但 C/C++ 在编码上并没有这样的
规定,凡符合 C/C++ 语法的就是合格的代码,但符合 C/C++
语法的代码不一定是优秀的代码,要对一些不良行为做约
定。
•
代码本身也可能会进行合作研发或后期维护,那么一个表
达统一、结构清楚的代码是必要的。
•
由这两点产生了编码规范,所以编码规范就是公司或团体
对代码编写的一个规定和约定 。
基本要求
•
程序结构清析,简单易懂,单个函数的行数建议在 50-100 行间
•
打算干什么,要简单,直接了当,代码精简,避免垃圾
•
尽量使用标准库函数和公共函数
•
不要随意定义全局变量,尽量使用局部变量
•
可读性第一,效率第二
•
保持注释与代码完全一致
•
每个源程序文件,都有文件头说明
•
每个函数,都有函数头说明
•
主要变量(结构、联合、类或对象)定义或引用时,注释能反映其含义
•
常量定义( DEFINE )有相应说明
•
处理过程的每个阶段都有相关注释说明
•
在典型算法前都有注释
•
循环、分支层次不要超过三层
•
注释可以与语句在同一行,也可以在上行
目 录
概述
文件体系结构
排版规则
注释规则
变量和结构
函数和过程
可测性要求
程序效率
质量保证
安全规则