发表于：2008/8/20 10:19:00
#0楼
01、版权和版本
02、缩进、空格、换行、空行、对齐
03、程序注释
04、函数的[in][out]参数
05、对系统调用的返回进行判断
06、if 语句对出错的处理
07、头文件中的#ifndef
08、在堆上分配内存
09、变量的初始化
10、h和c文件的使用
11、出错信息的处理
12、常用函数和循环语句中的被计算量
13、函数名和变量名的命名
14、函数的传值和传指针
15、修改别人程序的修养
16、把相同或近乎相同的代码形成函数和宏
17、表达式中的括号
18、函数参数中的const
19、函数的参数个数
20、函数的返回类型，不要省略
21、goto语句的使用
22、宏的使用
23、static的使用
24、函数中的代码尺寸
25、typedef的使用
26、为常量声明宏
27、不要为宏定义加分号
28、||和&&的语句执行顺序
29、尽量用for而不是while做循环
30、请sizeof类型而不是变量
31、不要忽略warning
32、书写debug版和release版的程序
1、版权和版本
———————
好的程序员会给自己的每个函数，每个文件，都注上版权和版本。
对于c/c++的文件，文件头应该有类似这样的注释：
/********************************************************************
*
* 文件名：network.c
*
* 文件描述：网络通讯函数集
*
* 创建人： hao chen, 2003年2月3日
*
* 版本号：1.0
*
* 修改记录：
*
********************************************************************/
而对于函数来说，应该也有类似于这样的注释：
/*============================================================
*
* 函 数 名：xxx
*
* 参 数：
*
* type name [in] : descripts
*
* 功能描述:
*
* ..............
*
* 返 回 值：成功true，失败false
*
* 抛出异常：
*
* 作 者：chenhao 2003/4/2
*
============================================================*/
这样的描述可以让人对一个函数，一个文件有一个总体的认识，对代码的易读性和易维护性有很大的好处。这是好的作品产生的开始。
作者: winston 发布日期: 2006-3-28
2、缩进、空格、换行、空行、对齐
————————————————
i) 缩进应该是每个程序都会做的，只要学程序过程序就应该知道这个，但是我仍然看过不缩进的程序，或是乱缩进的程序，如果你的公司还有写程序不缩进的程序员，请毫不犹豫的开除他吧，并以破坏源码罪起诉他，还要他赔偿读过他程序的人的精神损失费。缩进，这是不成文规矩，我再重提一下吧，一个缩进一般是一个tab键或是4个空格。（最好用tab键）
ii) 空格。空格能给程序代来什么损失吗？没有，有效的利用空格可以让你的程序读进来更加赏心悦目。而不一堆表达式挤在一起。看看下面的代码：
ha=(ha*128+*key++)%tabptr->size;
ha = ( ha * 128 + *key++ ) % tabptr->size;
有空格和没有空格的感觉不一样吧。一般来说，语句中要在各个操作符间加空格，函数调用时，要以各个参数间加空格。如下面这种加空格的和不加的：
if ((hproc=openprocess(process_all_access,false,pid))==null){
}
if ( ( hproc = openprocess(process_all_access, false, pid) ) == null ){
}
iii) 换行。不要把语句都写在一行上，这样很不好。如：
for(i=0;i9)&&(az)) break;
我拷，这种即无空格，又无换行的程序在写什么啊？加上空格和换行吧。
for ( i=0; i if ( ( a 9 ) &&
( a z ) ) {
break;
}
}
好多了吧？有时候，函数参数多的时候，最好也换行，如：
createprocess(
null,
cmdbuf,
null,
null,
binhh,
dwcrtflags,
envbuf,
null,
&sistartinfo,
&prinfo
);
条件语句也应该在必要时换行：
if ( ch >= 0 || ch = a || ch = a || ch
----------------------------------------------
3、程序注释
——————
养成写程序注释的习惯，这是每个程序员所必须要做的工作。我看过那种几千行，却居然没有一行注释的程序。这就如同在公路上驾车却没有路标一样。用不了多久，连自己都不知道自己的意图了，还要花上几倍的时间才看明白，这种浪费别人和自己的时间的人，是最为可耻的人。
是的，你也许会说，你会写注释，真的吗？注释的书写也能看出一个程序员的功底。一般来说你需要至少写这些地方的注释：文件的注释、函数的注释、变量的注释、算法的注释、功能块的程序注释。主要就是记录你这段程序是干什么的？你的意图是什么？你这个变量是用来做什么的？等等。
不要以为注释好写，有一些算法是很难说或写出来的，只能意会，我承认有这种情况的时候，但你也要写出来，正好可以训练一下自己的表达能力。而表达能力正是那种闷头搞技术的技术人员最缺的，你有再高的技术，如果你表达能力不行，你的技术将不能得到充分的发挥。因为，这是一个团队的时代。
好了，说几个注释的技术细节：
i) 对于行注释（“//”）比块注释（“/* */”）要好的说法，我并不是很同意。因为一些老版本的c编译器并不支持行注释，所以为了你的程序的移植性，请你还是尽量使用块注释。
ii) 你也许会为块注释的不能嵌套而不爽，那么你可以用预编译来完成这个功能。使用“#if 0”和“#endif”括起来的代码，将不被编译，而且还可以嵌套。
4、函数的[in][out]参数
———————————
我经常看到这样的程序：
funcname(char* str)
{
int len = strlen(str);
.....
}
char*
getusername(struct user* puser)
{
return puser->name;
}
不！请不要这样做。
你应该先判断一下传进来的那个指针是不是为空。如果传进来的指针为空的话，那么，你的一个大的系统就会因为这一个小的函数而崩溃。一种更好的技术是使用断言（assert），这里我就不多说这些技术细节了。当然，如果是在c++中，引用要比指针好得多，但你也需要对各个参数进行检查。
写有参数的函数时，首要工作，就是要对传进来的所有参数进行合法性检查。而对于传出的参数也应该进行检查，这个动作当然应该在函数的外部，也就是说，调用完一个函数后，应该对其传出的值进行检查。
当然，检查会浪费一点时间，但为了整个系统不至于出现“非法操作”或是“core dump”的系统级的错误，多花这点时间还是很值得的。
5、对系统调用的返回进行判断
——————————————
继续上一条，对于一些系统调用，比如打开文件，我经常看到，许多程序员对fopen返回的指针不做任何判断，就直接使用了。然后发现文件的内容怎么也读出不，或是怎么也写不进去。还是判断一下吧：
fp = fopen(log.txt, a);
if ( fp == null ){
printf(error: open file error\n);
return false;
}
其它还有许多啦，比如：socket返回的socket号，malloc返回的内存。请对这些系统调用返回的东西进行判断。
----------------------------------------------
6、if 语句对出错的处理
———————————
我看见你说了，这有什么好说的。还是先看一段程序代码吧。
if ( ch >= 0 && ch 9 ){
/* 输出错误信息 */
printf(error ......\n);
return ( false );
}
/* 正常处理代码 */
......
这样的结构，不是很清楚吗？突出了错误的条件，让别人在使用你的函数的时候，第一眼就能看到不合法的条件，于是就会更下意识的避免。
7、头文件中的#ifndef
——————————
千万不要忽略了头件的中的#ifndef，这是一个很关键的东西。比如你有两个c文件，这两个c文件都include了同一个头文件。而编译时，这两个c文件要一同编译成一个可运行文件，于是问题来了，大量的声明冲突。
还是把头文件的内容都放在#ifndef和#endif中吧。不管你的头文件会不会被多个文件引用，你都要加上这个。一般格式是这样的：
#ifndef
#define
......
......
#endif
在理论上来说可以是自由命名的，但每个头文件的这个“标识”都应该是唯一的。标识的命名规则一般是头文件名全大写，前后加下划线，并把文件名中的“.”也变成下划线，如：stdio.h
#ifndef _stdio_h_
#define _stdio_h_
......
#endif
（btw：预编译有多很有用的功能。你会用预编译吗？）
8、在堆上分配内存
—————————
可能许多人对内存分配上的“栈 stack”和“堆 heap”还不是很明白。包括一些科班出身的人也不明白这两个概念。我不想过多的说这两个东西。简单的来讲，stack上分配的内存系统自动释放，heap上分配的内存，系统不释放，哪怕程序退出，那一块内存还是在那里。stack一般是静态分配内存，heap上一般是动态分配内存。
由malloc系统函数分配的内存就是从堆上分配内存。从堆上分配的内存一定要自己释放。用free释放，不然就是术语——“内存泄露”（或是“内存漏洞”）—— memory leak。于是，系统的可分配内存会随malloc越来越少，直到系统崩溃。还是来看看“栈内存”和“堆内存”的差别吧。
栈内存分配
—————
char*
allocstrfromstack()
{
char pstr[100];
return pstr;
}
堆内存分配
—————
char*
allocstrfromheap(int len)
{
char *pstr;
if ( len
----------------------------------------------
10、h和c文件的使用
—————————
h文件和c文件怎么用呢？一般来说，h文件中是declare（声明），c文件中是define（定义）。因为c文件要编译成库文件（windows下是.obj/.lib，unix下是.o/.a），如果别人要使用你的函数，那么就要引用你的h文件，所以，h文件中一般是变量、宏定义、枚举、结构和函数接口的声明，就像一个接口说明文件一样。而c文件则是实现细节。
h文件和c文件最大的用处就是声明和实现分开。这个特性应该是公认的了，但我仍然看到有些人喜欢把函数写在h文件中，这种习惯很不好。（如果是c++话，对于其模板函数，在vc中只有把实现和声明都写在一个文件中，因为vc不支持export关键字）。而且，如果在h文件中写上函数的实现，你还得在makefile中把头文件的依赖关系也加上去，这个就会让你的makefile很不规范。
最后，有一个最需要注意的地方就是：带初始化的全局变量不要放在h文件中！
例如有一个处理错误信息的结构：
char* errmsg[] = {
/* 0 */ no error,
/* 1 */ open file error,
/* 2 */ failed in sending/receiving a message,
/* 3 */ bad arguments,
/* 4 */ memeroy is not enough,
/* 5 */ service is down; try later,
/* 6 */ unknow information,
/* 7 */ a socket operation has failed,
/* 8 */ permission denied,
/* 9 */ bad configuration file format,
/* 10 */ communication time out,
......
......
};
请不要把这个东西放在头文件中，因为如果你的这个头文件被5个函数库（.lib或是.a）所用到，于是他就被链接在这5个.lib或.a中，而如果你的一个程序用到了这5个函数库中的函数，并且这些函数都用到了这个出错信息数组。那么这份信息将有5个副本存在于你的执行文件中。如果你的这个errmsg很大的话，而且你用到的函数库更多的话，你的执行文件也会变得很大。
正确的写法应该把它写到c文件中，然后在各个需要用到errmsg的c文件头上加上 extern char* errmsg[]; 的外部声明，让编译器在链接时才去管他，这样一来，就只会有一个errmsg存在于执行文件中，而且，这样做很利于封装。
我曾遇到过的最疯狂的事，就是在我的目标文件中，这个errmsg一共有112个副本，执行文件有8m左右。当我把errmsg放到c文件中，并为一千多个c文件加上了extern的声明后，所有的函数库文件尺寸都下降了20%左右，而我的执行文件只有5m了。一下子少了3m啊。
〔 备注 〕
—————
有朋友对我说，这个只是一个特例，因为，如果errmsg在执行文件中存在多个副本时，可以加快程序运行速度，理由是errmsg的多个复本会让系统的内存换页降低，达到效率提升。像我们这里所说的errmsg只有一份，当某函数要用errmsg时，如果内存隔得比较远，会产生换页，反而效率不高。
这个说法不无道理，但是一般而言，对于一个比较大的系统，errmsg是比较大的，所以产生副本导致执行文件尺寸变大，不仅增加了系统装载时间，也会让一个程序在内存中占更多的页面。而对于errmsg这样数据，一般来说，在系统运行时不会经常用到，所以还是产生的内存换页也就不算频繁。权衡之下，还是只有一份errmsg的效率高。即便是像logmsg这样频繁使用的的数据，操作系统的内存调度算法会让这样的频繁使用的页面常驻于内存，所以也就不会出现内存换页问题了
11、出错信息的处理
—————————
你会处理出错信息吗？哦，它并不是简单的输出。看下面的示例：
if ( p == null ){
printf ( err: the pointer is null\n );
}
告别学生时代的编程吧。这种编程很不利于维护和管理，出错信息或是提示信息，应该统一处理，而不是像上面这样，写成一个“硬编码”。第10条对这方面的处理做了一部分说明。如果要管理错误信息，那就要有以下的处理：
/* 声明出错代码 */
#define err_no_error 0 /* no error */
#define err_open_file 1 /* open file error */
#define err_send_mesg 2 /* sending a message error */
#define err_bad_args 3 /* bad arguments */
#define err_mem_none 4 /* memeroy is not enough */
#define err_serv_down 5 /* service down try later */
#define err_unknow_info 6 /* unknow information */
#define err_socket_err 7 /* socket operation failed */
#define err_permission 8 /* permission denied */
#define err_bad_format 9 /* bad configuration file */
#define err_time_out 10 /* communication time out */
/* 声明出错信息 */
char* errmsg[] = {
/* 0 */ no error,
/* 1 */ open file error,
/* 2 */ failed in sending/receiving a message,
/* 3 */ bad arguments,
/* 4 */ memeroy is not enough,
/* 5 */ service is down; try later,
/* 6 */ unknow information,
/* 7 */ a socket operation has failed,
/* 8 */ permission denied,
/* 9 */ bad configuration file format,
/* 10 */ communication time out,
};
/* 声明错误代码全局变量 */
long errno = 0;
/* 打印出错信息函数 */
void perror( char* info)
{
if ( info ){
printf(%s: %s\n, info, errmsg[errno] );
return;
}
printf(error: %s\n, errmsg[errno] );
}
这个基本上是ansi的错误处理实现细节了，于是当你程序中有错误时你就可以这样处理：
bool checkpermission( char* username )
{
if ( strcpy(username, root) != 0 ){
errno = err_permission_denied;
return (false);
}
...
}
main()
{
...
if (! checkpermission( username ) ){
perror(main());
}
...
}
一个即有共性，也有个性的错误信息处理，这样做有利同种错误出一样的信息，统一用户界面，而不会因为文件打开失败，a程序员出一个信息，b程序员又出一个信息。而且这样做，非常容易维护。代码也易读。
当然，物极必反，也没有必要把所有的输出都放到errmsg中，抽取比较重要的出错信息或是提示信息是其关键，但即使这样，这也包括了大多数的信息。
----------------------------------------------
12、常用函数和循环语句中的被计算量
—————————————————
看一下下面这个例子：
for( i=0; i errcode, serverlistener -> servlisner，useraccount -> usracct 等。
5) 为了避免全局函数和变量名字冲突，可以加上一些前缀，一般以模块简称做为前缀。
6) 全局变量统一加一个前缀或是后缀，让人一看到这个变量就知道是全局的。
7) 用匈牙利命名法命名函数参数，局部变量。但还是要坚持“望文生意”的原则。
8) 与标准库（如：stl）或开发库（如：mfc）的命名风格保持一致。
作者: winston 发布日期: 2006-3-28
14、函数的传值和传指针
————————————
向函数传参数时，一般而言，传入非const的指针时，就表示，在函数中要修改这个指针把指内存中的数据。如果是传值，那么无论在函数内部怎么修改这个值，也影响不到传过来的值，因为传值是只内存拷贝。
什么？你说这个特性你明白了，好吧，让我们看看下面的这个例程：
void
getversion(char* pstr)
{
pstr = malloc(10);
strcpy ( pstr, 2.0 );
}
main()
{
char* ver = null;
getversion ( ver );
...
...
free ( ver );
}
我保证，类似这样的问题是一个新手最容易犯的错误。程序中妄图通过函数getversion给指针ver分配空间，但这种方法根本没有什么作用，原因就是——这是传值，不是传指针。你或许会和我争论，我分明传的时指针啊？再仔细看看，其实，你传的是指针其实是在传值。
15、修改别人程序的修养
———————————
当你维护别人的程序时，请不要非常主观臆断的把已有的程序删除或是修改。我经常看到有的程序员直接在别人的程序上修改表达式或是语句。修改别人的程序时，请不要删除别人的程序，如果你觉得别人的程序有所不妥，请注释掉，然后添加自己的处理程序，必竟，你不可能100%的知道别人的意图，所以为了可以恢复，请不依赖于cvs或是sourcesafe这种版本控制软件，还是要在源码上给别人看到你修改程序的意图和步骤。这是程序维护时，一个有修养的程序员所应该做的。
如下所示，这就是一种比较好的修改方法：
/*
* ----- commented by haoel 2003/04/12 ------
*
* char* p = ( char* ) malloc( 10 );
* memset( p, 0, 10 );
*/
/* ------ added by haoel 2003/04/12 ----- */
char* p = ( char* )calloc( 10, sizeof char );
/* ---------------------------------------- */
...
当然，这种方法是在软件维护时使用的，这样的方法，可以让再维护的人很容易知道以前的代码更改的动作和意图，而且这也是对原作者的一种尊敬。
以“注释 — 添加”方式修改别人的程序，要好于直接删除别人的程序。
16、把相同或近乎相同的代码形成函数和宏
—————————————————————
有人说，最好的程序员，就是最喜欢“偷懒”的程序，其中不无道理。
如果你有一些程序的代码片段很相似，或直接就是一样的，请把他们放在一个函数中。而如果这段代码不多，而且会被经常使用，你还想避免函数调用的开销，那么就把他写成宏吧。
千万不要让同一份代码或是功能相似的代码在多个地方存在，不然如果功能一变，你就要修改好几处地方，这种会给维护带来巨大的麻烦，所以，做到“一改百改”，还是要形成函数或是宏。
17、表达式中的括号
—————————
如果一个比较复杂的表达式中，你并不是很清楚各个操作符的忧先级，即使是你很清楚优先级，也请加上括号，不然，别人或是自己下一次读程序时，一不小心就看走眼理解错了，为了避免这种“误解”，还有让自己的程序更为清淅，还是加上括号吧。
比如，对一个结构的成员取地址：
getuserage( &( userinfo->age ) );
虽然，&userinfo->age中，->操作符的优先级最高，但加上一个括号，会让人一眼就看明白你的代码是什么意思。
再比如，一个很长的条件判断：
if ( ( ch[0] >= 0 || ch[0] = a || ch[1] = a || ch[2]
--------------------------------19、函数的参数个数（多了请用结构）
—————————————————
函数的参数个数最好不要太多，一般来说6个左右就可以了，众多的函数参数会让读代码的人一眼看上去就很头昏，而且也不利于维护。如果参数众多，还请使用结构来传递参数。这样做有利于数据的封装和程序的简洁性。
也利于使用函数的人，因为如果你的函数个数很多，比如12个，调用者很容易搞错参数的顺序和个数，而使用结构struct来传递参数，就可以不管参数的顺序。
而且，函数很容易被修改，如果需要给函数增加参数，不需要更改函数接口，只需更改结构体和函数内部处理，而对于调用函数的程序来说，这个动作是透明的。
作者: winston 发布日期: 2006-3-28
20、函数的返回类型，不要省略
——————————————
我看到很多程序写函数时，在函数的返回类型方面不太注意。如果一个函数没有返回值，也请在函数前面加上void的修饰。而有的程序员偷懒，在返回int的函数则什么不修饰（因为如果不修饰，则默认返回int），这种习惯很不好，还是为了原代码的易读性，加上int吧。
所以函数的返回值类型，请不要省略。
另外，对于void的函数，我们往往会忘了return，由于某些c/c++的编译器比较敏感，会报一些警告，所以即使是void的函数，我们在内部最好也要加上return的语句，这有助于代码的编译。
21、goto语句的使用
—————————
n年前，软件开发的一代宗师——迪杰斯特拉(dijkstra)说过：“goto statment is harmful !!”，并建议取消goto语句。因为goto语句不利于程序代码的维护性。
这里我也强烈建议不要使用goto语句，除非下面的这种情况：
#define free(p) if(p) { free(p); p = null; }
main()
{
char *fname=null, *lname=null, *mname=null;
fname = ( char* ) calloc ( 20, sizeof(char) );
if ( fname == null ){
goto errhandle;
}
lname = ( char* ) calloc ( 20, sizeof(char) );
if ( lname == null ){
goto errhandle;
}
mname = ( char* ) calloc ( 20, sizeof(char) );
if ( mname == null ){
goto errhandle;
}
......
errhandle:
free(fname);
free(lname);
free(mname);
reporterror(err_no_memoey);
}
也只有在这种情况下，goto语句会让你的程序更易读，更容易维护。（在用嵌c来对数据库设置游标操作时，或是对数据库建立链接时，也会遇到这种结构）
22、宏的使用
——————
很多程序员不知道c中的“宏”到底是什么意思？特别是当宏有参数的时候，经常把宏和函数混淆。我想在这里我还是先讲讲“宏”，宏只是一种定义，他定义了一个语句块，当程序编译时，编译器首先要执行一个“替换”源程序的动作，把宏引用的地方替换成宏定义的语句块，就像文本文件替换一样。这个动作术语叫“宏的展开”
使用宏是比较“危险”的，因为你不知道宏展开后会是什么一个样子。例如下面这个宏：
#define max(a, b) a>b?a:b
当我们这样使用宏时，没有什么问题： max( num1, num2 ); 因为宏展开后变成 num1>num2?num1:num2；。但是，如果是这样调用的，max( 17+32, 25+21 ); 呢，编译时出现错误，原因是，宏展开后变成：17+32>25+21?17+32:25+21，哇，这是什么啊？
所以，宏在使用时，参数一定要加上括号，上述的那个例子改成如下所示就能解决问题了。
#define max( (a), (b) ) (a)>(b)?(a):(b)
即使是这样，也不这个宏也还是有bug，因为如果我这样调用 max(i++, j++); ，经过这个宏以后，i和j都被累加了两次，这绝不是我们想要的。
所以，在宏的使用上还是要谨慎考虑，因为宏展开是的结果是很难让人预料的。而且虽然，宏的执行很快（因为没有函数调用的开销），但宏会让源代码澎涨，使目标文件尺寸变大，（如：一个50行的宏，程序中有1000个地方用到，宏展开后会很不得了），相反不能让程序执行得更快（因为执行文件变大，运行时系统换页频繁）。
因此，在决定是用函数，还是用宏时得要小心。
23、static的使用
————————
static关键字，表示了“静态”，一般来说，他会被经常用于变量和函数。一个static的变量，其实就是全局变量，只不过他是有作用域的全局变量。比如一个函数中的static变量：
char*
getconsumername()
{
static int cnt = 0;
....
cnt++;
....
}
cnt变量的值会跟随着函数的调用次而递增，函数退出后，cnt的值还存在，只是cnt只能在函数中才能被访问。而cnt的内存也只会在函数第一次被调用时才会被分配和初始化，以后每次进入函数，都不为static分配了，而直接使用上一次的值。
对于一些被经常调用的函数内的常量，最好也声明成static（参见第12条）
但static的最多的用处却不在这里，其最大的作用的控制访问，在c中如果一个函数或是一个全局变量被声明为static，那么，这个函数和这个全局变量，将只能在这个c文件中被访问，如果别的c文件中调用这个c文件中的函数，或是使用其中的全局（用extern关键字），将会发生链接时错误。这个特性可以用于数据和程序保密。
----------------------------------------------
--24、函数中的代码尺寸
——————————
一个函数完成一个具体的功能，一般来说，一个函数中的代码最好不要超过600行左右，越少越好，最好的函数一般在100行以内，300行左右的孙函数就差不多了。有证据表明，一个函数中的代码如果超过500行，就会有和别的函数相同或是相近的代码，也就是说，就可以再写另一个函数。
另外，函数一般是完成一个特定的功能，千万忌讳在一个函数中做许多件不同的事。函数的功能越单一越好，一方面有利于函数的易读性，另一方面更有利于代码的维护和重用，功能越单一表示这个函数就越可能给更多的程序提供服务，也就是说共性就越多。
虽然函数的调用会有一定的开销，但比起软件后期维护来说，增加一些运行时的开销而换来更好的可维护性和代码重用性，是很值得的一件事。
25、typedef的使用
—————————
typedef是一个给类型起别名的关键字。不要小看了它，它对于你代码的维护会有很好的作用。比如c中没有bool，于是在一个软件中，一些程序员使用int，一些程序员使用short，会比较混乱，最好就是用一个typedef来定义，如：
typedef char bool;
一般来说，一个c的工程中一定要做一些这方面的工作，因为你会涉及到跨平台，不同的平台会有不同的字长，所以利用预编译和typedef可以让你最有效的维护你的代码，如下所示：
#ifdef solaris2_5
typedef boolean_t bool_t;
#else
typedef int bool_t;
#endif
typedef short int16_t;
typedef unsigned short uint16_t;
typedef int int32_t;
typedef unsigned int uint32_t;
#ifdef win32
typedef _int64 int64_t;
#else
typedef long long int64_t;
#endif
typedef float float32_t;
typedef char* string_t;
typedef unsigned char byte_t;
typedef time_t time_t;
typedef int32_t pid_t;
使用typedef的其它规范是，在结构和函数指针时，也最好用typedef，这也有利于程序的易读和可维护性。如：
typedef struct _hostinfo {
hostid_t host;
int32_t hostid;
string_t hosttype;
string_t hostmodel;
float32_t cpufactor;
int32_t numcpus;
int32_t ndisks;
int32_t memory;
int32_t swap;
} hostinfo;
typedef int32_t (*rsrcreqhandler)(
void *info,
jobarray *jobs,
allocinfo *allocinfo,
alloclist *alloclist);
c++中这样也是很让人易读的：
typedef carray hostinfoarray;
于是，当我们用其定义变量时，会显得十分易读。如：
hostinfo* phinfo;
rsrcreqhandler* prsrchand;
这种方式的易读性，在函数的参数中十分明显。
关键是在程序种使用typedef后，几乎所有的程序中的类型声明都显得那么简洁和清淅，而且易于维护，这才是typedef的关键。
26、为常量声明宏
————————
最好不要在程序中出现数字式的“硬编码”，如：
int user[120];
为这个120声明一个宏吧。为所有出现在程序中的这样的常量都声明一个宏吧。比如timeout的时间，最大的用户数量，还有其它，只要是常量就应该声明成宏。如果，突然在程序中出现下面一段代码，
for ( i=0; i
----------------------------------------------
-27、不要为宏定义加分号
———————————
有许多程序员不知道在宏定义时是否要加分号，有时，他们以为宏是一条语句，应该要加分号，这就错了。当你知道了宏的原理，你会赞同我为会么不要为宏定义加分号的。看一个例子：
#define maxnum 1024;
这是一个有分号的宏，如果我们这样使用：
half = maxnum/2;
if ( num 0 ) { print_line; }
都不要在最后加上分号，当我们在程序中使用时，为之加上分号，
main()
{
char *p = line;
print_line;
}
这一点非常符合习惯，而且，如果忘加了分号，编译器给出的错误提示，也会让我们很容易看懂的。
28、||和&&的语句执行顺序
————————————
条件语句中的这两个“与”和“或”操作符一定要小心，它们的表现可能和你想像的不一样，这里条件语句中的有些行为需要和说一下：
express1 || express2
先执行表达式express1如果为“真”，express2将不被执行，express2仅在express1为“假”时才被执行。因为第一个表达式为真了，整个表达式都为真，所以没有必要再去执行第二个表达式了。
express1 && express2
先执行表达式express1如果为“假”，express2将不被执行，express2仅在express1为“真”时才被执行。因为第一个表达式为假了，整个表达式都为假了，所以没有必要再去执行第二个表达式了。
于是，他并不是你所想像的所有的表达式都会去执行，这点一定要明白，不然你的程序会出现一些莫明的运行时错误。
例如，下面的程序：
if ( sum > 100 &&
( ( fp=fopen( filename,a ) ) != null ) {
fprintf(fp, warring: it beyond one hundred\n);
......
}
fprintf( fp, sum is %id \n, sum );
fclose( fp );
本来的意图是，如果sum > 100 ，向文件中写一条出错信息，为了方便，把两个条件判断写在一起，于是，如果sumnext;
}
当while的语句块变大后，你的程序将很难读，用for就好得多：
for ( p=phead; p; p=p->next ){
..
}
一眼就知道这个循环的开始条件，结束条件，和循环的推进。大约就能明白这个循环要做个什么事？而且，程序维护进来很容易，不必像while一样，在一个编辑器中上上下下的捣腾。
作者: winston 发布日期: 2006-3-28
30、请sizeof类型而不是变量
—————————————
许多程序员在使用sizeof中，喜欢sizeof变量名，例如：
int score[100];
char filename[20];
struct userinfo usr[100];
在sizeof这三个的变量名时，都会返回正确的结果，于是许多程序员就开始sizeof变量名。这个习惯很虽然没有什么不好，但我还是建议sizeof类型。
我看到过这个的程序：
pscore = (int*) malloc( subject_cnt );
memset( pscore, 0, sizeof(pscore) );
...
此时，sizeof(pscore)返回的就是4（指针的长度），不会是整个数组，于是，memset就不能对这块内存进行初始化。为了程序的易读和易维护，我强烈建议使用类型而不是变量，如：
对于score： sizeof(int) * 100 /* 100个int */
对于filename： sizeof(char) * 20 /* 20个char */
对于usr： sizeof(struct userinfo) * 100 /* 100个userinfo */
这样的代码是不是很易读？一眼看上去就知道什么意思了。
另外一点，sizeof一般用于分配内存，这个特性特别在多维数组时，就能体现出其优点了。如，给一个字符串数组分配内存，
/*
* 分配一个有20个字符串，
* 每个字符串长100的内存
*/
char* *p;
/*
* 错误的分配方法
*/
p = (char**)calloc( 20*100, sizeof(char) );
/*
* 正确的分配方法
*/
p = (char**) calloc ( 20, sizeof(char*) );
for ( i=0; i
----------------------------------------------
此篇文章从博客转发
原文地址： Http://blog.gkong.com/more.asp?id=59344&Name=sfmcu
02、缩进、空格、换行、空行、对齐
03、程序注释
04、函数的[in][out]参数
05、对系统调用的返回进行判断
06、if 语句对出错的处理
07、头文件中的#ifndef
08、在堆上分配内存
09、变量的初始化
10、h和c文件的使用
11、出错信息的处理
12、常用函数和循环语句中的被计算量
13、函数名和变量名的命名
14、函数的传值和传指针
15、修改别人程序的修养
16、把相同或近乎相同的代码形成函数和宏
17、表达式中的括号
18、函数参数中的const
19、函数的参数个数
20、函数的返回类型，不要省略
21、goto语句的使用
22、宏的使用
23、static的使用
24、函数中的代码尺寸
25、typedef的使用
26、为常量声明宏
27、不要为宏定义加分号
28、||和&&的语句执行顺序
29、尽量用for而不是while做循环
30、请sizeof类型而不是变量
31、不要忽略warning
32、书写debug版和release版的程序
1、版权和版本
———————
好的程序员会给自己的每个函数，每个文件，都注上版权和版本。
对于c/c++的文件，文件头应该有类似这样的注释：
/********************************************************************
*
* 文件名：network.c
*
* 文件描述：网络通讯函数集
*
* 创建人： hao chen, 2003年2月3日
*
* 版本号：1.0
*
* 修改记录：
*
********************************************************************/
而对于函数来说，应该也有类似于这样的注释：
/*============================================================
*
* 函 数 名：xxx
*
* 参 数：
*
* type name [in] : descripts
*
* 功能描述:
*
* ..............
*
* 返 回 值：成功true，失败false
*
* 抛出异常：
*
* 作 者：chenhao 2003/4/2
*
============================================================*/
这样的描述可以让人对一个函数，一个文件有一个总体的认识，对代码的易读性和易维护性有很大的好处。这是好的作品产生的开始。
作者: winston 发布日期: 2006-3-28
2、缩进、空格、换行、空行、对齐
————————————————
i) 缩进应该是每个程序都会做的，只要学程序过程序就应该知道这个，但是我仍然看过不缩进的程序，或是乱缩进的程序，如果你的公司还有写程序不缩进的程序员，请毫不犹豫的开除他吧，并以破坏源码罪起诉他，还要他赔偿读过他程序的人的精神损失费。缩进，这是不成文规矩，我再重提一下吧，一个缩进一般是一个tab键或是4个空格。（最好用tab键）
ii) 空格。空格能给程序代来什么损失吗？没有，有效的利用空格可以让你的程序读进来更加赏心悦目。而不一堆表达式挤在一起。看看下面的代码：
ha=(ha*128+*key++)%tabptr->size;
ha = ( ha * 128 + *key++ ) % tabptr->size;
有空格和没有空格的感觉不一样吧。一般来说，语句中要在各个操作符间加空格，函数调用时，要以各个参数间加空格。如下面这种加空格的和不加的：
if ((hproc=openprocess(process_all_access,false,pid))==null){
}
if ( ( hproc = openprocess(process_all_access, false, pid) ) == null ){
}
iii) 换行。不要把语句都写在一行上，这样很不好。如：
for(i=0;i9)&&(az)) break;
我拷，这种即无空格，又无换行的程序在写什么啊？加上空格和换行吧。
for ( i=0; i if ( ( a 9 ) &&
( a z ) ) {
break;
}
}
好多了吧？有时候，函数参数多的时候，最好也换行，如：
createprocess(
null,
cmdbuf,
null,
null,
binhh,
dwcrtflags,
envbuf,
null,
&sistartinfo,
&prinfo
);
条件语句也应该在必要时换行：
if ( ch >= 0 || ch = a || ch = a || ch
----------------------------------------------
3、程序注释
——————
养成写程序注释的习惯，这是每个程序员所必须要做的工作。我看过那种几千行，却居然没有一行注释的程序。这就如同在公路上驾车却没有路标一样。用不了多久，连自己都不知道自己的意图了，还要花上几倍的时间才看明白，这种浪费别人和自己的时间的人，是最为可耻的人。
是的，你也许会说，你会写注释，真的吗？注释的书写也能看出一个程序员的功底。一般来说你需要至少写这些地方的注释：文件的注释、函数的注释、变量的注释、算法的注释、功能块的程序注释。主要就是记录你这段程序是干什么的？你的意图是什么？你这个变量是用来做什么的？等等。
不要以为注释好写，有一些算法是很难说或写出来的，只能意会，我承认有这种情况的时候，但你也要写出来，正好可以训练一下自己的表达能力。而表达能力正是那种闷头搞技术的技术人员最缺的，你有再高的技术，如果你表达能力不行，你的技术将不能得到充分的发挥。因为，这是一个团队的时代。
好了，说几个注释的技术细节：
i) 对于行注释（“//”）比块注释（“/* */”）要好的说法，我并不是很同意。因为一些老版本的c编译器并不支持行注释，所以为了你的程序的移植性，请你还是尽量使用块注释。
ii) 你也许会为块注释的不能嵌套而不爽，那么你可以用预编译来完成这个功能。使用“#if 0”和“#endif”括起来的代码，将不被编译，而且还可以嵌套。
4、函数的[in][out]参数
———————————
我经常看到这样的程序：
funcname(char* str)
{
int len = strlen(str);
.....
}
char*
getusername(struct user* puser)
{
return puser->name;
}
不！请不要这样做。
你应该先判断一下传进来的那个指针是不是为空。如果传进来的指针为空的话，那么，你的一个大的系统就会因为这一个小的函数而崩溃。一种更好的技术是使用断言（assert），这里我就不多说这些技术细节了。当然，如果是在c++中，引用要比指针好得多，但你也需要对各个参数进行检查。
写有参数的函数时，首要工作，就是要对传进来的所有参数进行合法性检查。而对于传出的参数也应该进行检查，这个动作当然应该在函数的外部，也就是说，调用完一个函数后，应该对其传出的值进行检查。
当然，检查会浪费一点时间，但为了整个系统不至于出现“非法操作”或是“core dump”的系统级的错误，多花这点时间还是很值得的。
5、对系统调用的返回进行判断
——————————————
继续上一条，对于一些系统调用，比如打开文件，我经常看到，许多程序员对fopen返回的指针不做任何判断，就直接使用了。然后发现文件的内容怎么也读出不，或是怎么也写不进去。还是判断一下吧：
fp = fopen(log.txt, a);
if ( fp == null ){
printf(error: open file error\n);
return false;
}
其它还有许多啦，比如：socket返回的socket号，malloc返回的内存。请对这些系统调用返回的东西进行判断。
----------------------------------------------
6、if 语句对出错的处理
———————————
我看见你说了，这有什么好说的。还是先看一段程序代码吧。
if ( ch >= 0 && ch 9 ){
/* 输出错误信息 */
printf(error ......\n);
return ( false );
}
/* 正常处理代码 */
......
这样的结构，不是很清楚吗？突出了错误的条件，让别人在使用你的函数的时候，第一眼就能看到不合法的条件，于是就会更下意识的避免。
7、头文件中的#ifndef
——————————
千万不要忽略了头件的中的#ifndef，这是一个很关键的东西。比如你有两个c文件，这两个c文件都include了同一个头文件。而编译时，这两个c文件要一同编译成一个可运行文件，于是问题来了，大量的声明冲突。
还是把头文件的内容都放在#ifndef和#endif中吧。不管你的头文件会不会被多个文件引用，你都要加上这个。一般格式是这样的：
#ifndef
#define
......
......
#endif
在理论上来说可以是自由命名的，但每个头文件的这个“标识”都应该是唯一的。标识的命名规则一般是头文件名全大写，前后加下划线，并把文件名中的“.”也变成下划线，如：stdio.h
#ifndef _stdio_h_
#define _stdio_h_
......
#endif
（btw：预编译有多很有用的功能。你会用预编译吗？）
8、在堆上分配内存
—————————
可能许多人对内存分配上的“栈 stack”和“堆 heap”还不是很明白。包括一些科班出身的人也不明白这两个概念。我不想过多的说这两个东西。简单的来讲，stack上分配的内存系统自动释放，heap上分配的内存，系统不释放，哪怕程序退出，那一块内存还是在那里。stack一般是静态分配内存，heap上一般是动态分配内存。
由malloc系统函数分配的内存就是从堆上分配内存。从堆上分配的内存一定要自己释放。用free释放，不然就是术语——“内存泄露”（或是“内存漏洞”）—— memory leak。于是，系统的可分配内存会随malloc越来越少，直到系统崩溃。还是来看看“栈内存”和“堆内存”的差别吧。
栈内存分配
—————
char*
allocstrfromstack()
{
char pstr[100];
return pstr;
}
堆内存分配
—————
char*
allocstrfromheap(int len)
{
char *pstr;
if ( len
----------------------------------------------
10、h和c文件的使用
—————————
h文件和c文件怎么用呢？一般来说，h文件中是declare（声明），c文件中是define（定义）。因为c文件要编译成库文件（windows下是.obj/.lib，unix下是.o/.a），如果别人要使用你的函数，那么就要引用你的h文件，所以，h文件中一般是变量、宏定义、枚举、结构和函数接口的声明，就像一个接口说明文件一样。而c文件则是实现细节。
h文件和c文件最大的用处就是声明和实现分开。这个特性应该是公认的了，但我仍然看到有些人喜欢把函数写在h文件中，这种习惯很不好。（如果是c++话，对于其模板函数，在vc中只有把实现和声明都写在一个文件中，因为vc不支持export关键字）。而且，如果在h文件中写上函数的实现，你还得在makefile中把头文件的依赖关系也加上去，这个就会让你的makefile很不规范。
最后，有一个最需要注意的地方就是：带初始化的全局变量不要放在h文件中！
例如有一个处理错误信息的结构：
char* errmsg[] = {
/* 0 */ no error,
/* 1 */ open file error,
/* 2 */ failed in sending/receiving a message,
/* 3 */ bad arguments,
/* 4 */ memeroy is not enough,
/* 5 */ service is down; try later,
/* 6 */ unknow information,
/* 7 */ a socket operation has failed,
/* 8 */ permission denied,
/* 9 */ bad configuration file format,
/* 10 */ communication time out,
......
......
};
请不要把这个东西放在头文件中，因为如果你的这个头文件被5个函数库（.lib或是.a）所用到，于是他就被链接在这5个.lib或.a中，而如果你的一个程序用到了这5个函数库中的函数，并且这些函数都用到了这个出错信息数组。那么这份信息将有5个副本存在于你的执行文件中。如果你的这个errmsg很大的话，而且你用到的函数库更多的话，你的执行文件也会变得很大。
正确的写法应该把它写到c文件中，然后在各个需要用到errmsg的c文件头上加上 extern char* errmsg[]; 的外部声明，让编译器在链接时才去管他，这样一来，就只会有一个errmsg存在于执行文件中，而且，这样做很利于封装。
我曾遇到过的最疯狂的事，就是在我的目标文件中，这个errmsg一共有112个副本，执行文件有8m左右。当我把errmsg放到c文件中，并为一千多个c文件加上了extern的声明后，所有的函数库文件尺寸都下降了20%左右，而我的执行文件只有5m了。一下子少了3m啊。
〔 备注 〕
—————
有朋友对我说，这个只是一个特例，因为，如果errmsg在执行文件中存在多个副本时，可以加快程序运行速度，理由是errmsg的多个复本会让系统的内存换页降低，达到效率提升。像我们这里所说的errmsg只有一份，当某函数要用errmsg时，如果内存隔得比较远，会产生换页，反而效率不高。
这个说法不无道理，但是一般而言，对于一个比较大的系统，errmsg是比较大的，所以产生副本导致执行文件尺寸变大，不仅增加了系统装载时间，也会让一个程序在内存中占更多的页面。而对于errmsg这样数据，一般来说，在系统运行时不会经常用到，所以还是产生的内存换页也就不算频繁。权衡之下，还是只有一份errmsg的效率高。即便是像logmsg这样频繁使用的的数据，操作系统的内存调度算法会让这样的频繁使用的页面常驻于内存，所以也就不会出现内存换页问题了
11、出错信息的处理
—————————
你会处理出错信息吗？哦，它并不是简单的输出。看下面的示例：
if ( p == null ){
printf ( err: the pointer is null\n );
}
告别学生时代的编程吧。这种编程很不利于维护和管理，出错信息或是提示信息，应该统一处理，而不是像上面这样，写成一个“硬编码”。第10条对这方面的处理做了一部分说明。如果要管理错误信息，那就要有以下的处理：
/* 声明出错代码 */
#define err_no_error 0 /* no error */
#define err_open_file 1 /* open file error */
#define err_send_mesg 2 /* sending a message error */
#define err_bad_args 3 /* bad arguments */
#define err_mem_none 4 /* memeroy is not enough */
#define err_serv_down 5 /* service down try later */
#define err_unknow_info 6 /* unknow information */
#define err_socket_err 7 /* socket operation failed */
#define err_permission 8 /* permission denied */
#define err_bad_format 9 /* bad configuration file */
#define err_time_out 10 /* communication time out */
/* 声明出错信息 */
char* errmsg[] = {
/* 0 */ no error,
/* 1 */ open file error,
/* 2 */ failed in sending/receiving a message,
/* 3 */ bad arguments,
/* 4 */ memeroy is not enough,
/* 5 */ service is down; try later,
/* 6 */ unknow information,
/* 7 */ a socket operation has failed,
/* 8 */ permission denied,
/* 9 */ bad configuration file format,
/* 10 */ communication time out,
};
/* 声明错误代码全局变量 */
long errno = 0;
/* 打印出错信息函数 */
void perror( char* info)
{
if ( info ){
printf(%s: %s\n, info, errmsg[errno] );
return;
}
printf(error: %s\n, errmsg[errno] );
}
这个基本上是ansi的错误处理实现细节了，于是当你程序中有错误时你就可以这样处理：
bool checkpermission( char* username )
{
if ( strcpy(username, root) != 0 ){
errno = err_permission_denied;
return (false);
}
...
}
main()
{
...
if (! checkpermission( username ) ){
perror(main());
}
...
}
一个即有共性，也有个性的错误信息处理，这样做有利同种错误出一样的信息，统一用户界面，而不会因为文件打开失败，a程序员出一个信息，b程序员又出一个信息。而且这样做，非常容易维护。代码也易读。
当然，物极必反，也没有必要把所有的输出都放到errmsg中，抽取比较重要的出错信息或是提示信息是其关键，但即使这样，这也包括了大多数的信息。
----------------------------------------------
12、常用函数和循环语句中的被计算量
—————————————————
看一下下面这个例子：
for( i=0; i errcode, serverlistener -> servlisner，useraccount -> usracct 等。
5) 为了避免全局函数和变量名字冲突，可以加上一些前缀，一般以模块简称做为前缀。
6) 全局变量统一加一个前缀或是后缀，让人一看到这个变量就知道是全局的。
7) 用匈牙利命名法命名函数参数，局部变量。但还是要坚持“望文生意”的原则。
8) 与标准库（如：stl）或开发库（如：mfc）的命名风格保持一致。
作者: winston 发布日期: 2006-3-28
14、函数的传值和传指针
————————————
向函数传参数时，一般而言，传入非const的指针时，就表示，在函数中要修改这个指针把指内存中的数据。如果是传值，那么无论在函数内部怎么修改这个值，也影响不到传过来的值，因为传值是只内存拷贝。
什么？你说这个特性你明白了，好吧，让我们看看下面的这个例程：
void
getversion(char* pstr)
{
pstr = malloc(10);
strcpy ( pstr, 2.0 );
}
main()
{
char* ver = null;
getversion ( ver );
...
...
free ( ver );
}
我保证，类似这样的问题是一个新手最容易犯的错误。程序中妄图通过函数getversion给指针ver分配空间，但这种方法根本没有什么作用，原因就是——这是传值，不是传指针。你或许会和我争论，我分明传的时指针啊？再仔细看看，其实，你传的是指针其实是在传值。
15、修改别人程序的修养
———————————
当你维护别人的程序时，请不要非常主观臆断的把已有的程序删除或是修改。我经常看到有的程序员直接在别人的程序上修改表达式或是语句。修改别人的程序时，请不要删除别人的程序，如果你觉得别人的程序有所不妥，请注释掉，然后添加自己的处理程序，必竟，你不可能100%的知道别人的意图，所以为了可以恢复，请不依赖于cvs或是sourcesafe这种版本控制软件，还是要在源码上给别人看到你修改程序的意图和步骤。这是程序维护时，一个有修养的程序员所应该做的。
如下所示，这就是一种比较好的修改方法：
/*
* ----- commented by haoel 2003/04/12 ------
*
* char* p = ( char* ) malloc( 10 );
* memset( p, 0, 10 );
*/
/* ------ added by haoel 2003/04/12 ----- */
char* p = ( char* )calloc( 10, sizeof char );
/* ---------------------------------------- */
...
当然，这种方法是在软件维护时使用的，这样的方法，可以让再维护的人很容易知道以前的代码更改的动作和意图，而且这也是对原作者的一种尊敬。
以“注释 — 添加”方式修改别人的程序，要好于直接删除别人的程序。
16、把相同或近乎相同的代码形成函数和宏
—————————————————————
有人说，最好的程序员，就是最喜欢“偷懒”的程序，其中不无道理。
如果你有一些程序的代码片段很相似，或直接就是一样的，请把他们放在一个函数中。而如果这段代码不多，而且会被经常使用，你还想避免函数调用的开销，那么就把他写成宏吧。
千万不要让同一份代码或是功能相似的代码在多个地方存在，不然如果功能一变，你就要修改好几处地方，这种会给维护带来巨大的麻烦，所以，做到“一改百改”，还是要形成函数或是宏。
17、表达式中的括号
—————————
如果一个比较复杂的表达式中，你并不是很清楚各个操作符的忧先级，即使是你很清楚优先级，也请加上括号，不然，别人或是自己下一次读程序时，一不小心就看走眼理解错了，为了避免这种“误解”，还有让自己的程序更为清淅，还是加上括号吧。
比如，对一个结构的成员取地址：
getuserage( &( userinfo->age ) );
虽然，&userinfo->age中，->操作符的优先级最高，但加上一个括号，会让人一眼就看明白你的代码是什么意思。
再比如，一个很长的条件判断：
if ( ( ch[0] >= 0 || ch[0] = a || ch[1] = a || ch[2]
--------------------------------19、函数的参数个数（多了请用结构）
—————————————————
函数的参数个数最好不要太多，一般来说6个左右就可以了，众多的函数参数会让读代码的人一眼看上去就很头昏，而且也不利于维护。如果参数众多，还请使用结构来传递参数。这样做有利于数据的封装和程序的简洁性。
也利于使用函数的人，因为如果你的函数个数很多，比如12个，调用者很容易搞错参数的顺序和个数，而使用结构struct来传递参数，就可以不管参数的顺序。
而且，函数很容易被修改，如果需要给函数增加参数，不需要更改函数接口，只需更改结构体和函数内部处理，而对于调用函数的程序来说，这个动作是透明的。
作者: winston 发布日期: 2006-3-28
20、函数的返回类型，不要省略
——————————————
我看到很多程序写函数时，在函数的返回类型方面不太注意。如果一个函数没有返回值，也请在函数前面加上void的修饰。而有的程序员偷懒，在返回int的函数则什么不修饰（因为如果不修饰，则默认返回int），这种习惯很不好，还是为了原代码的易读性，加上int吧。
所以函数的返回值类型，请不要省略。
另外，对于void的函数，我们往往会忘了return，由于某些c/c++的编译器比较敏感，会报一些警告，所以即使是void的函数，我们在内部最好也要加上return的语句，这有助于代码的编译。
21、goto语句的使用
—————————
n年前，软件开发的一代宗师——迪杰斯特拉(dijkstra)说过：“goto statment is harmful !!”，并建议取消goto语句。因为goto语句不利于程序代码的维护性。
这里我也强烈建议不要使用goto语句，除非下面的这种情况：
#define free(p) if(p) { free(p); p = null; }
main()
{
char *fname=null, *lname=null, *mname=null;
fname = ( char* ) calloc ( 20, sizeof(char) );
if ( fname == null ){
goto errhandle;
}
lname = ( char* ) calloc ( 20, sizeof(char) );
if ( lname == null ){
goto errhandle;
}
mname = ( char* ) calloc ( 20, sizeof(char) );
if ( mname == null ){
goto errhandle;
}
......
errhandle:
free(fname);
free(lname);
free(mname);
reporterror(err_no_memoey);
}
也只有在这种情况下，goto语句会让你的程序更易读，更容易维护。（在用嵌c来对数据库设置游标操作时，或是对数据库建立链接时，也会遇到这种结构）
22、宏的使用
——————
很多程序员不知道c中的“宏”到底是什么意思？特别是当宏有参数的时候，经常把宏和函数混淆。我想在这里我还是先讲讲“宏”，宏只是一种定义，他定义了一个语句块，当程序编译时，编译器首先要执行一个“替换”源程序的动作，把宏引用的地方替换成宏定义的语句块，就像文本文件替换一样。这个动作术语叫“宏的展开”
使用宏是比较“危险”的，因为你不知道宏展开后会是什么一个样子。例如下面这个宏：
#define max(a, b) a>b?a:b
当我们这样使用宏时，没有什么问题： max( num1, num2 ); 因为宏展开后变成 num1>num2?num1:num2；。但是，如果是这样调用的，max( 17+32, 25+21 ); 呢，编译时出现错误，原因是，宏展开后变成：17+32>25+21?17+32:25+21，哇，这是什么啊？
所以，宏在使用时，参数一定要加上括号，上述的那个例子改成如下所示就能解决问题了。
#define max( (a), (b) ) (a)>(b)?(a):(b)
即使是这样，也不这个宏也还是有bug，因为如果我这样调用 max(i++, j++); ，经过这个宏以后，i和j都被累加了两次，这绝不是我们想要的。
所以，在宏的使用上还是要谨慎考虑，因为宏展开是的结果是很难让人预料的。而且虽然，宏的执行很快（因为没有函数调用的开销），但宏会让源代码澎涨，使目标文件尺寸变大，（如：一个50行的宏，程序中有1000个地方用到，宏展开后会很不得了），相反不能让程序执行得更快（因为执行文件变大，运行时系统换页频繁）。
因此，在决定是用函数，还是用宏时得要小心。
23、static的使用
————————
static关键字，表示了“静态”，一般来说，他会被经常用于变量和函数。一个static的变量，其实就是全局变量，只不过他是有作用域的全局变量。比如一个函数中的static变量：
char*
getconsumername()
{
static int cnt = 0;
....
cnt++;
....
}
cnt变量的值会跟随着函数的调用次而递增，函数退出后，cnt的值还存在，只是cnt只能在函数中才能被访问。而cnt的内存也只会在函数第一次被调用时才会被分配和初始化，以后每次进入函数，都不为static分配了，而直接使用上一次的值。
对于一些被经常调用的函数内的常量，最好也声明成static（参见第12条）
但static的最多的用处却不在这里，其最大的作用的控制访问，在c中如果一个函数或是一个全局变量被声明为static，那么，这个函数和这个全局变量，将只能在这个c文件中被访问，如果别的c文件中调用这个c文件中的函数，或是使用其中的全局（用extern关键字），将会发生链接时错误。这个特性可以用于数据和程序保密。
----------------------------------------------
--24、函数中的代码尺寸
——————————
一个函数完成一个具体的功能，一般来说，一个函数中的代码最好不要超过600行左右，越少越好，最好的函数一般在100行以内，300行左右的孙函数就差不多了。有证据表明，一个函数中的代码如果超过500行，就会有和别的函数相同或是相近的代码，也就是说，就可以再写另一个函数。
另外，函数一般是完成一个特定的功能，千万忌讳在一个函数中做许多件不同的事。函数的功能越单一越好，一方面有利于函数的易读性，另一方面更有利于代码的维护和重用，功能越单一表示这个函数就越可能给更多的程序提供服务，也就是说共性就越多。
虽然函数的调用会有一定的开销，但比起软件后期维护来说，增加一些运行时的开销而换来更好的可维护性和代码重用性，是很值得的一件事。
25、typedef的使用
—————————
typedef是一个给类型起别名的关键字。不要小看了它，它对于你代码的维护会有很好的作用。比如c中没有bool，于是在一个软件中，一些程序员使用int，一些程序员使用short，会比较混乱，最好就是用一个typedef来定义，如：
typedef char bool;
一般来说，一个c的工程中一定要做一些这方面的工作，因为你会涉及到跨平台，不同的平台会有不同的字长，所以利用预编译和typedef可以让你最有效的维护你的代码，如下所示：
#ifdef solaris2_5
typedef boolean_t bool_t;
#else
typedef int bool_t;
#endif
typedef short int16_t;
typedef unsigned short uint16_t;
typedef int int32_t;
typedef unsigned int uint32_t;
#ifdef win32
typedef _int64 int64_t;
#else
typedef long long int64_t;
#endif
typedef float float32_t;
typedef char* string_t;
typedef unsigned char byte_t;
typedef time_t time_t;
typedef int32_t pid_t;
使用typedef的其它规范是，在结构和函数指针时，也最好用typedef，这也有利于程序的易读和可维护性。如：
typedef struct _hostinfo {
hostid_t host;
int32_t hostid;
string_t hosttype;
string_t hostmodel;
float32_t cpufactor;
int32_t numcpus;
int32_t ndisks;
int32_t memory;
int32_t swap;
} hostinfo;
typedef int32_t (*rsrcreqhandler)(
void *info,
jobarray *jobs,
allocinfo *allocinfo,
alloclist *alloclist);
c++中这样也是很让人易读的：
typedef carray hostinfoarray;
于是，当我们用其定义变量时，会显得十分易读。如：
hostinfo* phinfo;
rsrcreqhandler* prsrchand;
这种方式的易读性，在函数的参数中十分明显。
关键是在程序种使用typedef后，几乎所有的程序中的类型声明都显得那么简洁和清淅，而且易于维护，这才是typedef的关键。
26、为常量声明宏
————————
最好不要在程序中出现数字式的“硬编码”，如：
int user[120];
为这个120声明一个宏吧。为所有出现在程序中的这样的常量都声明一个宏吧。比如timeout的时间，最大的用户数量，还有其它，只要是常量就应该声明成宏。如果，突然在程序中出现下面一段代码，
for ( i=0; i
----------------------------------------------
-27、不要为宏定义加分号
———————————
有许多程序员不知道在宏定义时是否要加分号，有时，他们以为宏是一条语句，应该要加分号，这就错了。当你知道了宏的原理，你会赞同我为会么不要为宏定义加分号的。看一个例子：
#define maxnum 1024;
这是一个有分号的宏，如果我们这样使用：
half = maxnum/2;
if ( num 0 ) { print_line; }
都不要在最后加上分号，当我们在程序中使用时，为之加上分号，
main()
{
char *p = line;
print_line;
}
这一点非常符合习惯，而且，如果忘加了分号，编译器给出的错误提示，也会让我们很容易看懂的。
28、||和&&的语句执行顺序
————————————
条件语句中的这两个“与”和“或”操作符一定要小心，它们的表现可能和你想像的不一样，这里条件语句中的有些行为需要和说一下：
express1 || express2
先执行表达式express1如果为“真”，express2将不被执行，express2仅在express1为“假”时才被执行。因为第一个表达式为真了，整个表达式都为真，所以没有必要再去执行第二个表达式了。
express1 && express2
先执行表达式express1如果为“假”，express2将不被执行，express2仅在express1为“真”时才被执行。因为第一个表达式为假了，整个表达式都为假了，所以没有必要再去执行第二个表达式了。
于是，他并不是你所想像的所有的表达式都会去执行，这点一定要明白，不然你的程序会出现一些莫明的运行时错误。
例如，下面的程序：
if ( sum > 100 &&
( ( fp=fopen( filename,a ) ) != null ) {
fprintf(fp, warring: it beyond one hundred\n);
......
}
fprintf( fp, sum is %id \n, sum );
fclose( fp );
本来的意图是，如果sum > 100 ，向文件中写一条出错信息，为了方便，把两个条件判断写在一起，于是，如果sumnext;
}
当while的语句块变大后，你的程序将很难读，用for就好得多：
for ( p=phead; p; p=p->next ){
..
}
一眼就知道这个循环的开始条件，结束条件，和循环的推进。大约就能明白这个循环要做个什么事？而且，程序维护进来很容易，不必像while一样，在一个编辑器中上上下下的捣腾。
作者: winston 发布日期: 2006-3-28
30、请sizeof类型而不是变量
—————————————
许多程序员在使用sizeof中，喜欢sizeof变量名，例如：
int score[100];
char filename[20];
struct userinfo usr[100];
在sizeof这三个的变量名时，都会返回正确的结果，于是许多程序员就开始sizeof变量名。这个习惯很虽然没有什么不好，但我还是建议sizeof类型。
我看到过这个的程序：
pscore = (int*) malloc( subject_cnt );
memset( pscore, 0, sizeof(pscore) );
...
此时，sizeof(pscore)返回的就是4（指针的长度），不会是整个数组，于是，memset就不能对这块内存进行初始化。为了程序的易读和易维护，我强烈建议使用类型而不是变量，如：
对于score： sizeof(int) * 100 /* 100个int */
对于filename： sizeof(char) * 20 /* 20个char */
对于usr： sizeof(struct userinfo) * 100 /* 100个userinfo */
这样的代码是不是很易读？一眼看上去就知道什么意思了。
另外一点，sizeof一般用于分配内存，这个特性特别在多维数组时，就能体现出其优点了。如，给一个字符串数组分配内存，
/*
* 分配一个有20个字符串，
* 每个字符串长100的内存
*/
char* *p;
/*
* 错误的分配方法
*/
p = (char**)calloc( 20*100, sizeof(char) );
/*
* 正确的分配方法
*/
p = (char**) calloc ( 20, sizeof(char*) );
for ( i=0; i
----------------------------------------------
此篇文章从博客转发
原文地址： Http://blog.gkong.com/more.asp?id=59344&Name=sfmcu