文档介绍：技术部编码规范

开发环境:
开发时操作系统采用widows系列
编码采用标准C、C51、汇编中的一种或几种混合编码;一般情况下以C51为主;
编译工具采用Keil公司的Keil uVersion 2编译器;
编辑工具采用UltraEdit;(在不影响编码规范也可用其它的编辑工具)
编码规范:
注释:
注释要简单明了,边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性,在必要的地方注释,注释量要适中。注释的内容要清楚、明了,含义准确,防止注释二义性。
保持注释与其描述的代码相邻,即注释的就近原则,对代码的注释应放在其上方相邻位置或右边,不可放在下面,对数据结构的注释应放在其上方相邻位置,不可放在下面;对结构中的每个域的注释应放在此域的右方;同一结构中不同域的注释要对齐,全局变量要有较详细的注释,包括对其功能、取值范围、哪些函数或过程存取它,以及存取时注意事项等的说明。
采用中文注释,专用术语采用英文或数字;除以下规定的特殊形式的注释外其它的均以“//”开头,不用“/* */”;
几种常用注释的示例:
单元开头的注释:(每个编码单元及相关说明文档都必须有),如:
单元内函数、变量的注释:
2、命名规则:(命名必须具有一定的实际意义)
(1)常量:用大写字母,如:
(2)变量:用小写字母,多个词之间用下划线连接,如:
(3)一般函数:用小写字母,多个词之间用下划线连接, 在定义函数时,在函数名后面括号中直接进行形式参数说明,不再另行说明。如:

函数:以小写字母vd开头,必需存放在keil\inc\vdlib目录上,其余要求同一般函数;库函数所在单元名也必须以vd开头,如:
3、编辑风格:
缩进:缩进以 Tab 为单位,一个 Tab 为四个空格大小。预处理语句、全局数据、函数原型、标题、附加说明、函数说明、标号等均顶格书写。语句块的“{”“}”配对对齐,并与其前一行对齐;
空格:数据和函数在其类型,修饰名称之间适当空格并据情况对齐。关键字原则上空一格,如: if ( ... ) 等,运算符的空格规定如下:“->”、“[”、“]”、“++”、“--”、“~”、“!”、“+”、“-”(指正负号),“&”(取址或引用)、“*”(指使用指针时)等几个运算符两边不空格(其中单目运算符系指与操作数相连的一边),其它运算符(包括大多数二目运算符和三目运算符“?:”两边均空一格,“(”、“)”运算符在其内侧空一格,在作函数定义时还可据情况多空或不空格来对齐,但在函数实现时可以不用。“,”运算符只在其后空一格,需对齐时也可不空或多空格,对语句行后加的注释应用适当空格与语句隔开并尽可能对齐。
对齐:原则上关系密切的行应对齐,对齐包括类型、修饰、名称、参数等各部分对齐。另每一行的长度不应超过屏幕太多,必要时适当换行,换行时尽可能在“,”处或运算符处,换行后最好以运算符打头,并且以下各行均以该语句首行缩进,但该语句仍以首行的缩进为准,即如其下一行为“{”应与首行对齐。
空行:程序文件结构各部分之间空两行,若不必要也可只空一行,各函数实现之间一般空两行
修改:版本封存以后的修改一定要将老语句用/* */ 封闭,不能自行删除或修改,并要在文件及函数的修改记录中加以记录。
语句:较长的语句、表