谈谈C51的编程规范

Hh0203

现在单片机的程序设计，C51已经得到广泛的推广和应用，算是单片机的主流设计程序，甚至可以说作为单片机开发人员必须要掌握的一门语言了。

    作为一门工具，最终的目的就是实现功能。在满足这个前提条件下，我们希望我们的程序能很容易地被别人读懂，或者能够很容易地读懂别人的程序，在团体合作开发中就能起到事半功倍之效。在网上请求帮助时，如能以规范的写法贴出程序，网友会比较容易地明白你的问题，则会比较快的得到网友的帮助，否则让人看上半天也不明所以然，这样就达不到预期的效果了。因此，为了便于源程序的交流，减少合作开发中的障碍，希望大家能够探讨一下C51的编程规范。把各人认为好的建议提出来，然后做一个总结，作为一种大家一致认同的规范，我认为将会是一件很有意义的事。我先提出一些自已的想法，以此抛砖引玉。
) p& a* S' C+ G  o: |' }7 j
一、注释
1 _4 [: b# }( v2 X( G% R% }
; H  q/ s! N+ r8 i1，采用中文；
2，开始的注释：
. N; ]/ r3 k; ]( e8 [1 n0 t6 l4 i/ H  Z
文件(模块)注释内容：
/ G6 a% d3 A/ G# e公司名称、版权、作者名称、修改时间、模块功能、背景介绍等,复杂的算法需要加上流程说明;

比如：
/*********************************************************************/
$ M2 M4 k0 \% E7 _/ n/*公司名称: */
& v5 I. S8 H' \2 a2 D8 E
/*模 块 名： LCD 模块 LCD 型号：HD44780 */
% t( ]# h  B) s" q$ x* X
$ L- w$ Z) E1 i8 T) O* W' m/*创 建 人：zhaojunjie 日期：2001-06-08 */
! e7 C& l6 a# f/*修 改 人： 日期：2001-06-08 */
/*功能描述： */
* k- r1 U$ q0 P5 l" |/*其他说明： */
/ M  i7 A0 l5 \8 h& n( R/*版 本：
9 ^2 _( [7 m% |1 X6 i' ]2 ~/**********************************************************************/

函数开头的注释内容：
/ a* d% S' f5 H! f8 `3 O& E' e& X0 J函数名称、功能、说明 输入、返回、函数描述、流程处理、全局变量、调用样例等,复杂的函数需要加上变量用途说明;
5 `+ q! Y3 t- s. S
6 S8 A0 A; s4 S9 p; }" @4 X/*********************************************************************
' W& b3 o8 P8 f; W- w4 D$ {* X7 I*
8 I9 ?% @3 `- ?0 u* 函 数 名: v_LcdInit
* 功能描述: LCD初始化
* 函数说明: 初始化命令：0x3c, 0x08, 0x01, 0x06, 0x10, 0x0c
* 调用函数: v_Delaymsec(),v_LcdCmd()
* 全局变量:
* 输 入: 无
* 返 回: 无
* 设 计 者：zhao 日期：2001-12-09
9 Y' Q9 O5 j) G) t- _1 v3 e* 修 改 者：zhao 日期：2001-12-09
* 版 本：
***********************************************************************/
3 n) r3 V' L  \0 r3 h$ u+ t
  s6 Y. Y! `" Q9 I; o* z, S3、程序中的注释内容：

修改时间和作者、方便理解的注释等。注释内容应简炼、清楚、明了，一目了然的语句不加注释。
' ?% H. M7 z5 Q( f9 c
二、命名：
& ^1 ]4 R+ C: ?! Q* t; G$ e* B/ l
命名必须具有一定的实际意义。
# Z6 Y+ ]- l5 A6 k+ s
1、常量的命名：全部用大写。
4 @- L; R/ V4 Z# ~
5 n4 i  U# p/ D2 a% J0 j2、变量的命名：
变量名加前缀，前缀反映变量的数据类型，用小写，反映变量意义的第一个字母大写，其他小写。
其中变量数据类型：
! P; m0 o# u$ c! L6 W+ aunsigned char 前缀 uc signed char 前缀 sc
6 b& ?. h4 c# zunsigned int 前缀 ui signed int 前缀 si
; l7 \3 U0 O) `2 s! `unsigned long 前缀 ul signed long 前缀 sl
$ P/ M$ i8 N4 n; R7 E$ Jbit 前缀 b 指针 前缀 p
' c/ r6 C7 ?/ w. j" z8 l$ t  H
# H8 }5 j7 p: c/ J+ u2 [! H6 W7 a" E例：ucReceivData 接收数据
+ d3 B4 ^+ E4 @, N3、结构体命名：

4、函数的命名：
1 w$ e# M/ {7 ~1 \1 @函数名首字大写，若包含有两个单词的每个单词首字母大写。
函数原型说明包括：引用外来函数及内部函数，外部引用必须在右侧注明函数来源： 模块名及文件名, 内部函数，只要注释其定义文件名;

. T! o2 d) G: V& m三、编辑风格

1、缩进：缩进以 Tab 为单位，一个 Tab 为四个空格大小。预处理语句、全局数据、函数原型、标题、附加说明、函数说明、标号等均顶格书写。语句块的“{”“}”配对对齐，并与其前一行对齐；
2 q5 |8 u( o. }3 N
$ K' @% N: U4 |- U6 P' Y" w2、空格：数据和函数在其类型，修饰名称之间适当空格并据情况对齐。关键字原则上空一格，如：
6 e! j$ k& K: _' g3 uif ( ... ) 等，运算符的空格规定如下：“->”、“[”、“]”、“++”、“--”、“~”、“!”、“+”、“-”（指正负号），“&”（取址或引用）、“*”（指使用指针时）等几个运算符两边不空格（其中单目运算符系指与操作数相连的一边），其它运算符（包括大多数二目运算符和三目运算符“?:”两边均空一格，“(”、“)”运算符在其内侧空一格，在作函数定义时还可据情况多空或不空格来对齐，但在函数实现时可以不用。“,”运算符只在其后空一格，需对齐时也可不空或多空格，对语句行后加的注释应用适当空格与语句隔开并尽可能对齐。
8 Z4 Q. D2 s) c
  O- `: Y8 g2 O, V3、对齐：原则上关系密切的行应对齐，对齐包括类型、修饰、名称、参数等各部分对齐。另每一行的长度不应超过屏幕太多，必要时适当换行，换行时尽可能在“,”处或运算符处，换行后最好以运算符打头，并且以下各行均以该语句首行缩进，但该语句仍以首行的缩进为准，即如其下一行为“{”应与首行对齐。
7 m  N8 p" f+ f, @$ ]6 J
4、空行：程序文件结构各部分之间空两行，若不必要也可只空一行，各函数实现之间一般空两行
& b+ V$ m) f7 |8 f- x! x- U, p
7 o0 v- a# L, o; U$ J5、修改：版本封存以后的修改一定要将老语句用/* */ 封闭，不能自行删除或修改,并要在文件及函数的修改记录中加以记录。
& o; {  i) E. p5 q, D
  i, R1 C! h1 Y' \7 k* R6、形参：在定义函数时，在函数名后面括号中直接进行形式参数说明，不再另行说明。

cyxs

楼主辛苦了！

Gegu

谢谢分享,必须赞一个～
9 s6 B5 R3 p7 s1 l6 M) j. ]# l9 H