谈谈C51的编程规范

Hh0203

现在单片机的程序设计，C51已经得到广泛的推广和应用，算是单片机的主流设计程序，甚至可以说作为单片机开发人员必须要掌握的一门语言了。
8 }5 c- v; O, r/ K! t+ N
    作为一门工具，最终的目的就是实现功能。在满足这个前提条件下，我们希望我们的程序能很容易地被别人读懂，或者能够很容易地读懂别人的程序，在团体合作开发中就能起到事半功倍之效。在网上请求帮助时，如能以规范的写法贴出程序，网友会比较容易地明白你的问题，则会比较快的得到网友的帮助，否则让人看上半天也不明所以然，这样就达不到预期的效果了。因此，为了便于源程序的交流，减少合作开发中的障碍，希望大家能够探讨一下C51的编程规范。把各人认为好的建议提出来，然后做一个总结，作为一种大家一致认同的规范，我认为将会是一件很有意义的事。我先提出一些自已的想法，以此抛砖引玉。

一、注释

1，采用中文；
2，开始的注释：

5 T# X. K6 e" t文件(模块)注释内容：
/ Q0 d0 i8 O5 V2 b5 ^% r公司名称、版权、作者名称、修改时间、模块功能、背景介绍等,复杂的算法需要加上流程说明;
9 C( K* \8 i) t
" O7 p1 w5 Y7 `, F& ^4 N# I比如：
/ h# W& u# C( f8 Z/*********************************************************************/
5 E% |4 ?: h2 }, ?, D/*公司名称: */
  W) k" d* t% o) D) }8 k0 Q# ]
/*模 块 名： LCD 模块 LCD 型号：HD44780 */

0 D5 H: I8 R$ B- y( l/*创 建 人：zhaojunjie 日期：2001-06-08 */
/*修 改 人： 日期：2001-06-08 */
& x, g, Y- g8 Y& {  [/*功能描述： */
/*其他说明： */
/*版 本：
/**********************************************************************/
( N/ X7 }  @. p- ^
函数开头的注释内容：
" ^/ z; N% u- \函数名称、功能、说明 输入、返回、函数描述、流程处理、全局变量、调用样例等,复杂的函数需要加上变量用途说明;
3 u  h( F7 b9 B. S1 B
6 |5 Z8 J7 m/ V# l5 l8 g/*********************************************************************
*
+ I, K+ d4 c/ Y+ T2 F- ^& R. ~* 函 数 名: v_LcdInit
8 P) v  i0 ~8 g/ D* 功能描述: LCD初始化
2 y+ }8 C6 M8 g) `  g: P, B* 函数说明: 初始化命令：0x3c, 0x08, 0x01, 0x06, 0x10, 0x0c
) {8 S8 e: t2 o3 ?4 j- l+ L+ b# P$ G* 调用函数: v_Delaymsec(),v_LcdCmd()
* 全局变量:
/ x4 o' t- t) e6 \6 b6 n' j* 输 入: 无
* 返 回: 无
& _: P: J$ j# I* 设 计 者：zhao 日期：2001-12-09
+ c" S2 u# i2 i8 R+ q* 修 改 者：zhao 日期：2001-12-09
* 版 本：
***********************************************************************/
; D8 \$ ~, X# C) G) l
3、程序中的注释内容：
% E& c, t: i5 L3 m9 p: s
修改时间和作者、方便理解的注释等。注释内容应简炼、清楚、明了，一目了然的语句不加注释。
$ {% y$ a0 ]; S5 l
0 d1 l) ^5 _! u  T& [. [9 b" Q; B二、命名：
1 Z1 Y% ?* w. r, s8 D) h
" d- N1 W- ]# u% j. \- S1 W0 u命名必须具有一定的实际意义。
/ @7 ^4 n) u! E5 B  K( R5 E: t
1、常量的命名：全部用大写。

3 O) @, j/ R3 @* |& g6 m/ _0 n2、变量的命名：
8 Y" f% z5 L" w# Q6 J. F4 U变量名加前缀，前缀反映变量的数据类型，用小写，反映变量意义的第一个字母大写，其他小写。
' J) I; c0 w% z3 e6 q* R" D# }2 ?其中变量数据类型：
unsigned char 前缀 uc signed char 前缀 sc
- T1 u- E8 B1 C5 t( J" q2 V& Hunsigned int 前缀 ui signed int 前缀 si
unsigned long 前缀 ul signed long 前缀 sl
0 D6 ~0 f' i" K5 G1 Ybit 前缀 b 指针 前缀 p

例：ucReceivData 接收数据
# L3 @0 j" i! H5 {/ B. |3、结构体命名：

4、函数的命名：
函数名首字大写，若包含有两个单词的每个单词首字母大写。
函数原型说明包括：引用外来函数及内部函数，外部引用必须在右侧注明函数来源： 模块名及文件名, 内部函数，只要注释其定义文件名;
% H4 f5 Y* F; Z# C$ @
: i: c0 R5 V" f! }三、编辑风格

1、缩进：缩进以 Tab 为单位，一个 Tab 为四个空格大小。预处理语句、全局数据、函数原型、标题、附加说明、函数说明、标号等均顶格书写。语句块的“{”“}”配对对齐，并与其前一行对齐；
1 c: G7 P$ M2 F
: P) c+ m. B' M' I& H4 }" r) P2、空格：数据和函数在其类型，修饰名称之间适当空格并据情况对齐。关键字原则上空一格，如：
, N! s0 `( O  D! Y, C$ j% uif ( ... ) 等，运算符的空格规定如下：“->”、“[”、“]”、“++”、“--”、“~”、“!”、“+”、“-”（指正负号），“&”（取址或引用）、“*”（指使用指针时）等几个运算符两边不空格（其中单目运算符系指与操作数相连的一边），其它运算符（包括大多数二目运算符和三目运算符“?:”两边均空一格，“(”、“)”运算符在其内侧空一格，在作函数定义时还可据情况多空或不空格来对齐，但在函数实现时可以不用。“,”运算符只在其后空一格，需对齐时也可不空或多空格，对语句行后加的注释应用适当空格与语句隔开并尽可能对齐。

( O9 g3 a3 I1 A- _, a, ]- @4 A3、对齐：原则上关系密切的行应对齐，对齐包括类型、修饰、名称、参数等各部分对齐。另每一行的长度不应超过屏幕太多，必要时适当换行，换行时尽可能在“,”处或运算符处，换行后最好以运算符打头，并且以下各行均以该语句首行缩进，但该语句仍以首行的缩进为准，即如其下一行为“{”应与首行对齐。
# w  ~8 V% J" u  U2 ]2 O. b
4、空行：程序文件结构各部分之间空两行，若不必要也可只空一行，各函数实现之间一般空两行
) L4 m! V  x# G' h6 F4 z0 {# O
& t0 |& n4 f8 Q4 `0 d% C4 N( o! o5 q5、修改：版本封存以后的修改一定要将老语句用/* */ 封闭，不能自行删除或修改,并要在文件及函数的修改记录中加以记录。
' O, g0 r( k( H# j* q$ W
6、形参：在定义函数时，在函数名后面括号中直接进行形式参数说明，不再另行说明。

Gegu

谢谢分享,必须赞一个～
, w: K4 J" V. Y6 U8 M; v$ G' a# ~7 g

cyxs

楼主辛苦了！
0 F- k  i1 c) Q. A8 H! p