谈谈C51的编程规范

小黄豆

现在单片机的程序设计，C51已经得到广泛的推广和应用，算是单片机的主流设计程序，甚至可以说作为单片机开发人员必须要掌握的一门语言了。5 n* T# o& f( h' y( m. C2 P+ O- j# o

    作为一门工具，最终的目的就是实现功能。在满足这个前提条件下，我们希望我们的程序能很容易地被别人读懂，或者能够很容易地读懂别人的程序，在团体合作开发中就能起到事半功倍之效。在网上请求帮助时，如能以规范的写法贴出程序，网友会比较容易地明白你的问题，则会比较快的得到网友的帮助，否则让人看上半天也不明所以然，这样就达不到预期的效果了。因此，为了便于源程序的交流，减少合作开发中的障碍，希望大家能够探讨一下C51的编程规范。把各人认为好的建议提出来，然后做一个总结，作为一种大家一致认同的规范，我认为将会是一件很有意义的事。我先提出一些自已的想法，以此抛砖引玉。+ d  Z3 I) t3 y" U& A* j1 `  o& E
  H6 N& Z: f7 z, a$ B0 }
一、注释
7 p' n5 r1 h3 r, [, V$ f
1，采用中文；
2，开始的注释：; d1 z9 v( e, U1 W* C6 u$ m

文件(模块)注释内容：
公司名称、版权、作者名称、修改时间、模块功能、背景介绍等,复杂的算法需要加上流程说明;

比如：
/*********************************************************************/
/*公司名称: */

/*模 块 名： LCD 模块 LCD 型号：HD44780 */
: F* v. Q4 J2 T" F
/*创 建 人：zhaojunjie 日期：2001-06-08 */
/*修 改 人： 日期：2001-06-08 */ 0 k5 K+ X. `0 N; }- @% b
/*功能描述： */
/*其他说明： */, G2 k" R- R  a% g- w
/*版 本：
/**********************************************************************/6 r0 v1 H3 A7 L$ ^' G: O

函数开头的注释内容：# r6 m) Q3 ^4 C. C
函数名称、功能、说明 输入、返回、函数描述、流程处理、全局变量、调用样例等,复杂的函数需要加上变量用途说明;7 B; p, B+ m) p3 k: I4 Y1 u' e

/*********************************************************************
** L2 ?& K# m4 c4 c
* 函 数 名: v_LcdInit/ Y' Z( E) n& V
* 功能描述: LCD初始化3 ?4 V9 w8 l/ y/ l0 S
* 函数说明: 初始化命令：0x3c, 0x08, 0x01, 0x06, 0x10, 0x0c% s2 Y+ }! k% R5 n4 ], T2 w
* 调用函数: v_Delaymsec(),v_LcdCmd()7 V6 R1 |- l  w3 G
* 全局变量:1 n1 @3 j+ q& b# z: \0 O( b
* 输 入: 无. R5 P" h- _& z1 z: j
* 返 回: 无
* 设 计 者：zhao 日期：2001-12-09
* 修 改 者：zhao 日期：2001-12-09' s' N: D8 E/ S: H" s  J- E/ s' e
* 版 本：
***********************************************************************/
" e  P+ E* f% j
3、程序中的注释内容：
$ }) G' F' L0 Z% @9 p
修改时间和作者、方便理解的注释等。注释内容应简炼、清楚、明了，一目了然的语句不加注释。

二、命名：4 U( y4 N2 p- X  F1 o$ b

命名必须具有一定的实际意义。$ @# [8 n# |( s0 r! Q; A: b$ R

1、常量的命名：全部用大写。9 b; R: U/ E; Z3 `7 B+ U0 N
" q6 B* A  q6 M, ^4 l5 f" |
2、变量的命名：# N$ X9 L7 w$ V$ R
变量名加前缀，前缀反映变量的数据类型，用小写，反映变量意义的第一个字母大写，其他小写。 . M* j0 w% m/ p! x1 U' m
其中变量数据类型：
unsigned char 前缀 uc signed char 前缀 sc 9 O$ N$ J8 F: G6 ~5 H
unsigned int 前缀 ui signed int 前缀 si
unsigned long 前缀 ul signed long 前缀 sl
bit 前缀 b 指针 前缀 p9 v" t& s& E- l7 Z

例：ucReceivData 接收数据
3、结构体命名：+ l( {: C2 N  B% H
: }) z' j1 s* e7 `
4、函数的命名：
函数名首字大写，若包含有两个单词的每个单词首字母大写。
函数原型说明包括：引用外来函数及内部函数，外部引用必须在右侧注明函数来源： 模块名及文件名, 内部函数，只要注释其定义文件名;2 Z9 F# K! o1 a

三、编辑风格3 g9 X# ?6 N8 s  v
3 P9 n* Q) i( D
1、缩进：缩进以 Tab 为单位，一个 Tab 为四个空格大小。预处理语句、全局数据、函数原型、标题、附加说明、函数说明、标号等均顶格书写。语句块的“{”“}”配对对齐，并与其前一行对齐；

2、空格：数据和函数在其类型，修饰名称之间适当空格并据情况对齐。关键字原则上空一格，如：   f9 d% x% Q. H0 h
if ( ... ) 等，运算符的空格规定如下：“->”、“[”、“]”、“++”、“--”、“~”、“!”、“+”、“-”（指正负号），“&”（取址或引用）、“*”（指使用指针时）等几个运算符两边不空格（其中单目运算符系指与操作数相连的一边），其它运算符（包括大多数二目运算符和三目运算符“?:”两边均空一格，“(”、“)”运算符在其内侧空一格，在作函数定义时还可据情况多空或不空格来对齐，但在函数实现时可以不用。“,”运算符只在其后空一格，需对齐时也可不空或多空格，对语句行后加的注释应用适当空格与语句隔开并尽可能对齐。: K7 i4 ^* g1 ?. Z; n
5 n! @1 k: J. {
3、对齐：原则上关系密切的行应对齐，对齐包括类型、修饰、名称、参数等各部分对齐。另每一行的长度不应超过屏幕太多，必要时适当换行，换行时尽可能在“,”处或运算符处，换行后最好以运算符打头，并且以下各行均以该语句首行缩进，但该语句仍以首行的缩进为准，即如其下一行为“{”应与首行对齐。6 X% f5 k6 U: q& S, k
3 g2 v, Q# |* G% I. D8 ]
4、空行：程序文件结构各部分之间空两行，若不必要也可只空一行，各函数实现之间一般空两行

5、修改：版本封存以后的修改一定要将老语句用/* */ 封闭，不能自行删除或修改,并要在文件及函数的修改记录中加以记录。. x" P8 ?" E& R' l" t- q
: b9 \( o, {) W0 Q, O
6、形参：在定义函数时，在函数名后面括号中直接进行形式参数说明，不再另行说明。