C语言编程规范

C语言编程规范  

1. 基本要求
1.1 程序结构清析，简单易懂，单个函数的程序行数不得超过100行。
1.2 打算干什么，要简单，直接了当，代码精简，避免垃圾程序。
1.3 尽量使用标准库函数和公共函数。
1.4 不要随意定义全局变量，尽量使用局部变量。
1.5 使用括号以避免二义性。

2.可读性要求
2.1 可读性第一，效率第二。
2.2 保持注释与代码完全一致。
2.3 每个源程序文件，都有文件头说明，说明规格见规范。
2.4 每个函数，都有函数头说明，说明规格见规范。
2.5 主要变量（结构、联合、类或对象）定义或引用时，注释能反映其含义。
2.7 常量定义（DEFINE）有相应说明。
2.8 处理过程的每个阶段都有相关注释说明。
2.9 在典型算法前都有注释。
2.10 利用缩进来显示程序的逻辑结构，缩进量一致并以Tab键为单位，定义Tab为 6个
字节。
2.11 循环、分支层次不要超过五层。
2.12 注释可以与语句在同一行，也可以在上行。
2.13 空行和空白字符也是一种特殊注释。
2.14 一目了然的语句不加注释。
2.15 注释的作用范围可以为：定义、引用、条件分支以及一段代码。
2.16 注释行数（不包括程序头和函数头说明部份）应占总行数的 1/5 到 1/3 。

3. 结构化要求
3.1 禁止出现两条等价的支路。
3.2 禁止GOTO语句。
3.3 用 IF 语句来强调只执行两组语句中的一组。禁止 ELSE GOTO 和 ELSE RETURN。
3.4 用 CASE 实现多路分支。
3.5 避免从循环引出多个出口。
3.6 函数只有一个出口。
3.7 不使用条件赋值语句。
3.8 避免不必要的分支。
3.9 不要轻易用条件分支去替换逻辑表达式。

4. 正确性与容错性要求
4.1 程序首先是正确，其次是优美
4.2 无法证明你的程序没有错误，因此在编写完一段程序后，应先回头检查。
4.3 改一个错误时可能产生新的错误，因此在修改前首先考虑对其它程序的影响。
4.4 所有变量在调用前必须被初始化。
4.5 对所有的用户输入，必须进行合法性检查。
4.6 不要比较浮点数的相等，
如： 10.0 * 0.1 == 1.0 ， 不可靠
4.7 程序与环境或状态发生关系时，必须主动去处理发生的意外事件，如文件能否
逻辑锁定、打印机是否联机等。
4.8 单元测试也是编程的一部份，提交联调测试的程序必须通过单元测试。

5. 可重用性要求
5.1 重复使用的完成相对独立功能的算法或代码应抽象为公共控件或类。
5.2 公共控件或类应考虑OO思想，减少外界联系，考虑独立性或封装性。
5.3 公共控件或类应建立使用模板。
　　　　　　　　　 附：C＋＋ 编程规范,delphi作相应的参考

1适用范围
本标准适用于利用Visul C++ ,Borland C++进行软件程序开发的人员.。

.2变量命名
命名必须具有一定的实际意义,形式为xAbcFgh,x由变量类型确定,Abc、Fgh表示连续意
义字符串,如果连续意义字符串仅两个,可都大写.如OK.
具体例程:
BOOL类型　　　　　　　　 bEnable;

ch　　 *　　　　　　 char　　　　　　　　　　　　　 chText
c　　 *　　　　　　 类对象　　　　　　　　　　　　 cMain（对象实例）
h　　 *　　　　　　 Handle（句柄）　　　　　　　　 hWnd
i　　 *　　　　　　 int
n　　 *　　　　　　 无符号整型
p　　 *　　　　　　 指针
sz,str *　　　　　　 字符串
w　　　　　　　　　　 WORD
x,y　　　　　　　　　 坐标
Char或者TCHAR类型　　　 与Windows API有直接联系的用szAppName[10]形式否则用
FileName[10]形式,单个字符也可用小写字母表示;
Int类型　　　　　　　　　 nCmdShow;
LONG类型　　　　　　　　 lParam;
UINT类型　　　　　　　　 uNotify;
DWORD类型　　　　　　　 dwStart;
PSTR类型　　　　　　　　 pszTip;
LPSTR类型　　　　　　　 lpCmdLine
LPTSTR类型　　　　　　　 lpszClassName;
LPVOID类型　　　　　　　 lpReserved

WPARAM类型　　　　　　 wParam,
LPARAM类型　　　　　　　 lParam
HWND类型　　　　　　　　 hDlg;
HDC类型　　　　　　　　　 hDC;
HINSTANCE类型　　　　　 hInstance
HANDLE类型　　　　　　　 hInstance,
HICON类型　　　　　　　　 hIcon;
int　　　　　　　　　　　　 iTmp
float　　　　　　　　　　　　 fTmp
DWORD　　　　　　　　　 dw*
String , AnsiString　　　　　　 str *
m_　　　　　　　　　　 类成员变量　　　　　　　　　　 m_nVal, m_bFlag
g_　　　　　　　　　　 全局变量　　　　　　　　　　　 g_nMsg, g_bFlag
局部变量中可采用如下几个通用变量：nTemp，nResult，I，J（一般用于循环变量）。
其他资源句柄同上
.3常量命名和宏定义
常量和宏定义必须具有一定的实际意义;
常量和宏定义在＃i nclude和函数定义之间;
常量和宏定义必须全部以大写字母来撰写,中间可根据意义的连续性用下划线连接,每一
条定义的右侧必须有一简单的注释,说明其作用;
资源名字定义格式:
菜单:IDM_XX或者CM_XX
位图:IDB_XX
对话框:IDD_XX
字符串:IDS_XX
DLGINIT:DIALOG_XX
　ICON:IDR_XX
.4函数命名
函数原型说明包括引用外来函数及内部函数，外部引用必须在右侧注明函数来源：模
块名及文件名, 如是内部函数，只要注释其定义文件名;
第一个字母必须使用大写字母,要求用大小写字母组合规范函数命名,必要时可用下划线
间隔,示例如下：
void　UpdateDB_Tfgd (TRACK_NAME);　 file://Module　Name :r01/sdw.c
void　PrintTrackData (TRACK_NAME); file://Module Name :r04/tern.c
void　ImportantPoint (void);　　　　　 file://Module　Name :r01/sdw.c
void　ShowChar (int , int , chtype);　 file://Local Module
void　ScrollUp_V　(int , int);　　　　　 file://Local Module
.5结构体命名
结构体类型命名必须全部用大写字母,原则上前面以下划线开始;结构体变量命名必须用
大小写字母组合，第一个字母必须使用大写字母,必要时可用下划线间隔。对于私有数
据区，必须注明其所属的进程。全局数据定义只需注意其用途。
　　　　　　　　　 示例如下：
　　　　　　　　　 typedef struct
　　　　　　　　　 {
　　　　　　　　　　　　　 char 　　　　　　　 szProductName[20];
　　　　　　　　　　　　　 char 　　　　　　　 szAuthor[20];

　　　　　　　　　　　　　 char 　　　　　　　 szReleaseDate[16];
　　　　　　　　　　　　　 char 　　　　　　　 szVersion[10];
　　　　　　　　　　　　　 unsigned long　　　 MaxTables;
　　　　　　　　　　　　　 unsigned long　　　 UsedTables;
}DBS_DATABASE;
DBS_DATABASE GdataBase;

6 控件的命名：
用小写前缀表示类别
用小写前缀表示类别：
fm　　　　　　 窗口
cmd　　　　　 按钮
cob　　　　　 combo，下拉式列表框
txt　　　　　 文本输入框
lab　　　　　 labal，标签
img　　　　　 image，图象
pic　　　　　 picture
grd　　　　　 Grid，网格
scr　　　　　 滚动条
lst　　　　　 列表框
frm　　　　　 fram

7注释
原则上注释要求使用中文;
文件开始注释内容包括:公司名称、版权、作者名称、时间、模块用途、背景介绍等,复
杂的算法需要加上流程说明;
函数注释包括:输入、输出、函数描述、流程处理、全局变量、调用样例等,复杂的函数
需要加上变量用途说明;
程序中注释包括:修改时间和作者、方便理解的注释等;
-----------------------------------------------------

第一章:缩进格式

　　Tab是8个字符,于是缩进也是8个字符.有很多怪异的风格,他们将缩进格式定义为4个字符(设置为2个字符!)的深度,这就象试图将PI定义为3一样让人难以接受.

　　理由是:缩进的大小是为了清楚的定义一个块的开始和结束.特别是当你已经在计算机前面呆了20多个小时了以后,你会发现一个大的缩进格式使得你对程序的理解更容易.

　　现在,有一些人说,使用8个字符的缩进使得代码离右边很近,在80个字符宽度的终端屏幕上看程序很难受.回答是,但你的程序有3个以上的缩进的时候,你就应该修改你的程序.
　　
总之,8个字符的缩进使得程序易读,还有一个附加的好处,就是它能在你将程序变得嵌套层数太多的时候给你警告.这个时候,你应该修改你的程序.

第二章:大符号的位置

　　另外一个C程序编程风格的问题是对大括号的处理.同缩进大小不同,几乎没有什么理由去选择一种而不选择另外一种风格,但有一种推荐的风格,它是Kernighan和Ritchie的经典的那本书带来的,它将开始
的大括号放在一行的最后,而将结束大括号放在一行的第一位,如下所示:

　　if (x is true) { we do y }
　　
　　然而,还有一种特殊的情况:命名函数:开始的括号是放在下一行的第一位,如下:
int function(int x) { body of function }
　　
　　所有非正统的人会非难这种不一致性,但是,所有思维正常的人明白: (第一) K&R是___对___的,(第二)如果K&R不对,请参见第一条. (:-))......另外,函数也是特殊的,不一定非得一致.

　　需要注意的是结束的括号在它所占的那一行是空的,__除了__它跟随着同一条语句的继续符号.如while在do-while循环中,或者else在if语句中.如下:

　　do { body of do-loop } while (condition);
　　以及
　　if (x == y) { .. } else if (x > y) { ... } else { .... }

　　理由: K&R.
　　
　　另外,注意到这种大括号的放置方法减小了空行的数量,但却没有减少可读性.于是,在屏幕大小受到限制的时候,你就可以有更多的空行来写些注释了.

第三章:命名系统

　　C是一种简洁的语言,那么,命名也应该是简洁的.同MODULE-2以及ASCAL语言不同的是,C程序员不使用诸如ThisVariableIsATemporaryCounter之类的命名方式.一个C语言的程序员会将之命名为tmp,这很容易书写,且并不是那么难以去理解.

　　然而,当混合类型的名字不得不出现的时候,描述性名字对全局变量来说是必要的了.调用一个名为foo全局的函数是很让人恼火的.全局变量(只有你必须使用的时候才使用它) ,就象全局函数一样,需要描述性的命名方式.假如你有一个函数用来计算活动用户的数量,你应该这样命名--count_active_users()--或另外的相近的形式,你不应命名为cntusr().

　　有一种称为Hungarian命名方式,它将函数的类型编码写入变量名中,这种方式是脑子有毛病的一种表现---编译器知道这个类型而且会去检查它,而这样只会迷惑程序员. --知道为什么Micro$oft为什么会生产这么多臭虫程序了把!!.

　　局部变量的命名应该短小精悍.假如你有一个随机的整数循环计数器,它有可能有i,如果没有任何可能使得它能被误解的话,将其写作loop_counter是效率低下的.同样的,tmp可以是任何临时数值的函数变量.

　　如果你害怕混淆你的局部变量的名字,还有另外一个问题,就是称
function-growth-hormone-imbalancesyndrome.

第四章:函数

　　函数应该短小而迷人,而且它只作一件事情.它应只覆盖一到两个屏幕(80*24一屏),并且只作一件事情,而且将它做好.(这不就是UNIX的风格吗,译者注).

　　一个函数的最大长度和函数的复杂程度以及缩进大小成反比.于是,如果你已经写了简单但长度较长的的函数,而且你已经对不同的情况做了很多很小的事情,写一个更长一点的函数也是无所谓的.

　　然而,假如你要写一个很复杂的函数,而且你已经估计到假如一般人读这个函数,他可能都不知道这个函数在说些什么,这个时候,使用具有描述性名字的有帮助的函数.

　　另外一个需要考虑的是局部变量的数量.他们不应该超过5-10个,否则你有可能会出错.重新考虑这个函数,将他们分割成更小的函数.人的大脑通常可以很容易的记住7件不同的事情,超过这个数量会引起混乱.你知道你很聪明,但是你可能仍想去明白2周以前的做的事情.

第5章:注释

　　注释是一件很好的事情,但是过多的注释也是危险的,不要试图区解释你的代码是注释如何如何的好:你应该将代码写得更好,而不是花费大量的时间去解释那些糟糕的代码.

　　通常情况下,你的注释是说明你的代码做些什么,而不是怎么做的.而且,要试图避免将注释插在一个函数体里:假如这个函数确实很复杂,你需要在其中有部分的注释,你应该回到第四章看看.你可以写些简短的注释来注明或警告那些你认为特别聪明(或极其丑陋)的部分,但是你必须要避免过多.取而代之的是,将注释写在函数前,告诉别人它做些什么事情,和可能为什么要这样做.

第六章:你已经深陷其中了.

　　不要着急.你有可能已经被告之GUN emacs会自动的帮你处理C的源代码格式,而且你已经看到它确实如此,但是,缺省的情况下,它的作用还是不尽如人意(实际上,他们比随便敲出来的东西还要难看- ainfinite number of monkeys typing into GNU emacs would never make a good program)

　　于是,你可以要么不要使用GUN emacs,要么让它使用sanervalules.使用后者,你需要将如下的语句输入到你的.emacs文件中.(defun linux-c-mode() C mode with adjusted defaults for use with the Linux kernel.(interactive) (c-mode) (c-set-styleK&R) (setq c-basic-offset8))
　　
　　这会定义一个M-x Linux-c-mode的命令.当你hacking一个模块的时候,如何你将-*- linux-c -*-输入在最开始的两行,这个模式会自动起作用.而且,你也许想加入如下

　　(setq auto-mode-alist (cons (/usr/src/linux.*/.*\.〖ch〗$ . linux-c-mode) auto-mode-alist))
　　
　　到你的.emacs文件中,这样的话,当你在/usr/src/linux下编辑文件的时候,它会自动切换到linux-c-mode .

　　但是,假如你还不能让emaces去自动处理文件的格式,不要紧张,你还有一样东西: 缩进 .

　　GNU的缩进格式也很死板,这就是你为什么需要加上几行命令选项.然而,这还不算太坏,因为GNU缩进格式的创造者也记得K&R的权威, (GNU没有罪,他们仅仅是在这件事情上错误的引导了人们) ,你要做的就只有输入选项-kr -i8(表示K&R,缩进8个字符).

　　缩进有很多功能,特别是当它建议你重新格式你的代码的时候,你应该看看帮助.但要记住: 缩进不是风格很差的程序的万灵丹.