编程修养

编程修养 什么是好的程序员？是不是懂得很多技术细节？还是懂底层编程？还是编程速度比 较快？我觉得都不是。对于一些技术细节来说和底层的技术，只要看帮助，查资料 就能找到，对于速度快，只要编得多也就熟能生巧了。 我认为好的程序员应该有以下几方面的素质： 1、有专研精神，勤学善问、举一反三。 2、积极向上的态度，有创造性思维。 3、与人积极交流沟通的能力，有团队精神。 4、谦虚谨慎，戒骄戒燥。 5、写出的代码质量高。包括：代码的稳定、易读、规范、易维护、专业。 这些都是程序员的修养，这里我想谈谈"编程修养"，也就是上述中的第 5 点。我觉 得，如果我要了解一个作者，我会看他所写的小说，如果我要了解一个画家，我会 看他所画的图画，如果我要了解一个工人，我会看他所做出来的产品，同样，如果 我要了解一个程序员，我想首先我最想看的就是他的程序代码，程序代码可以看出 一个程序员的素质和修养，程序就像一个作品，有素质有修养的程序员的作品必然 是一图精美的图画，一首美妙的歌曲，一本赏心悦目的小说。 我看过许多程序，没有注释，没有缩进，胡乱命名的变量名，等等，等等，我把这 种人统称为没有修养的程序，这种程序员，是在做创造性的工作吗？不，完全就是 在搞破坏，他们与其说是在编程，还不如说是在对源程序进行"加密"，这种程序 员，见一个就应该开除一个，因为他编的程序所创造的价值，远远小于需要在上面 进行维护的价值。 程序员应该有程序员的修养，那怕再累，再没时间，也要对自己的程序负责。我宁 可要那种动作慢，技术一般，但有良好的写程序风格的程序员，也不要那种技术 强、动作快的"搞破坏"的程序员。有句话叫"字如其人"，我想从程序上也能看出一 个程序员的优劣。因为，程序是程序员的作品，作品的好坏直截关系到程序员的声 誉和素质。而"修养"好的程序员一定能做出好的程序和软件。 有个成语叫"独具匠心"，意思是做什么都要做得很专业，很用心，如果你要做一个 "匠"，也就是造诣高深的人，那么，从一件很简单的作品上就能看出你有没有"匠" 的特性，我觉得做一个程序员不难，但要做一个"程序匠"就不简单了。编程序很简 单，但编出有质量的程序就难了。 我在这里不讨论过深的技术，我只想在一些容易让人忽略的东西上说一说，虽然这 些东西可能很细微，但如果你不注意这些细微之处的话，那么他将会极大的影响你 的整个软件质量，以及整个软件程的实施，所谓"千里之堤，毁于蚁穴"。 "细微之处见真功"，真正能体现一个程序的功底恰恰在这些细微之处。 这就是程序员的--编程修养。我 总结 初级经济法重点总结下载党员个人总结TXt高中句型全总结.doc高中句型全总结.doc理论力学知识点总结pdf 了在用 C/C++语言（主要是 C 语言）进行程序 写作上的三十二个"修养"，通过这些，你可以写出质量高的程序，同时也会让看你 程序的人渍渍称道，那些看过你程序的人一定会说："这个人的编程修养不错"。 ------------------------ 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 * ============================================================*/ 这样的描述可以让人对一个函数，一个文件有一个总体的认识，对代码的易读性和 易维护性有很大的好处。这是好的作品产生的开始。 2、缩进、空格、换行、空行、对齐 ---------------- i) 缩进应该是每个程序都会做的，只要学程序过程序就应该知道这个，但是我仍然 看过不缩进的程序，或是乱缩进的程序，如果你的公司还有写程序不缩进的程序 员，请毫不犹豫的开除他吧，并以破坏源码罪起诉他，还要他赔偿读过他程序的人 的精神损失费。缩进，这是不成文规矩，我再重提一下吧，一个缩进一般是一个 TAB 键或是 4 个空格。（最好用 TAB 键） ii) 空格。空格能给程序代来什么损失吗？没有，有效的利用空格可以让你的程序 读进来更加赏心悦目。而不一堆表达式挤在一起。看看下面的代码： Administrator 高亮 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;i<'0'||a[i]>'9')&&(a[i]<'a'||a[i]>'z')) break; 这种即无空格，又无换行的程序在写什么啊？加上空格和换行吧。 for ( i=0; i if ( ( a[i] < '0' || a[i] > '9' ) && ( a[i] < 'a' || a[i] > 'z' ) ) { break; } } 好多了吧？有时候，函数参数多的时候，最好也换行，如： CreateProcess( NULL, cmdbuf, NULL, NULL, bInhH, dwCrtFlags, envbuf, NULL, &siStartInfo, &prInfo ); 条件语句也应该在必要时换行： if ( ch >= '0' || ch <= '9' || ch >= 'a' || ch <= 'z' || ch >= 'A' || ch <= 'Z' ) iv) 空行。不要不加空行，空行可以区分不同的程序块，程序块间，最好加上空 行。如： HANDLE hProcess; PROCESS_T procInfo; /* open the process handle */ if((hProcess = OpenProcess(PROCESS_ALL_ACCESS, FALSE, pid)) == NULL) Administrator 高亮 Administrator 高亮 Administrator 高亮 { return LSE_MISC_SYS; } memset(&procInfo, 0, sizeof(procInfo)); procInfo.idProc = pid; procInfo.hdProc = hProcess; procInfo.misc |= MSCAVA_PROC; return(0); v) 对齐。用 TAB 键对齐你的一些变量的声明或注释，一样会让你的程序好看一 些。如： typedef struct _pt_man_t_ { int numProc; /* Number of processes */ int maxProc; /* Max Number of processes */ int numEvnt; /* Number of events */ int maxEvnt; /* Max Number of events */ HANDLE* pHndEvnt; /* Array of events */ DWORD timeout; /* Time out interval */ HANDLE hPipe; /* Namedpipe */ TCHAR usr[MAXUSR];/* User name of the process */ int numMsg; /* Number of Message */ int Msg[MAXMSG];/* Space for intro process communicate */ } PT_MAN_T; 怎么样？感觉不错吧。 这里主要讲述了如果写出让人赏心悦目的代码，好看的代码会让人的心情愉快，读 起代码也就不累，工整、整洁的程序代码，通常更让人欢迎，也更让人称道。现在 的硬盘空间这么大，不要让你的代码挤在一起，这样它们会抱怨你虐待它们的。好 了，用"缩进、空格、换行、空行、对齐"装饰你的代码吧，让他们从没有秩序的土 匪中变成一排排整齐有秩序的正规部队吧。 3、程序注释 ------ 养成写程序注释的习惯，这是每个程序员所必须要做的工作。我看过那种几千行， 却居然没有一行注释的程序。这就如同在公路上驾车却没有路标一样。用不了多 久，连自己都不知道自己的意图了，还要花上几倍的时间才看明白，这种浪费别人 和自己的时间的人，是最为可耻的人。 是的，你也许会说，你会写注释，真的吗？注释的书写也能看出一个程序员的功 底。一般来说你需要至少写这些地方的注释：文件的注释、函数的注释、变量的注 释、算法的注释、功能块的程序注释。主要就是记录你这段程序是干什么的？你的 意图是什么？你这个变量是用来做什么的？等等。 不要以为注释好写，有一些算法是很难说或写出来的，只能意会，我承认有这种情 况的时候，但你也要写出来，正好可以训练一下自己的表达能力。而表达能力正是 那种闷头搞技术的技术人员最缺的，你有再高的技术，如果你表达能力不行，你的 Administrator 高亮 Administrator 高亮 Administrator 高亮 Administrator 高亮 技术将不能得到充分的发挥。因为，这是一个团队的时代。 好了，说几个注释的技术细节： 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 返回的内存。请对这些系 统调用返回的东西进行判断。 Administrator 高亮 Administrator 高亮 Administrator 高亮 Administrator 高亮 Administrator 高亮 Administrator 高亮 6、if 语句对出错的处理 ----------- 我看见你说了，这有什么好说的。还是先看一段程序代码吧。 if ( ch >= '0' && ch <= '9' ){ /* 正常处理代码 */ }else{ /* 输出错误信息 */ printf("error ......\n"); return ( FALSE ); } 这种结构很不好，特别是如果"正常处理代码"很长时，对于这种情况，最好不要用 else。先判断错误，如： 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 <= 0 ) return NULL; return ( char* ) malloc( len ); } 对于第一个函数，那块 pstr 的内存在函数返回时就被系统释放了。于是所返回的 char*什么也没有。而对于第二个函数，是从堆上分配内存，所以哪怕是程序退出 时，也不释放，所以第二个函数的返回的内存没有问题，可以被使用。但一定要调 用 free 释放，不然就是 Memory Leak！ 在堆上分配内存很容易造成内存泄漏，这是 C/C++的最大的"克星"，如果你的程序 要稳定，那么就不要出现 Memory Leak。所以，我还是要在这里千叮咛万嘱付，在 使用 malloc 系统函数（包括 calloc，realloc）时千万要小心。 记得有一个 UNIX 上的服务应用程序，大约有几百的 C 文件编译而成，运行测试 良好，等使用时，每隔三个月系统就是 down 一次，搞得许多人焦头烂额，查不出 问题所在。只好，每隔两个月人工手动重启系统一次。出现这种问题就是 Memery Leak 在做怪了，在 C/C++中这种问题总是会发生，所以你一定要小心。一个 Rational 的检测工作--Purify，可以帮你测试你的程序有没有内存泄漏。 我保证，做过许多 C/C++的工程的程序员，都会对 malloc 或是 new 有些感冒。当 你什么时候在使用 malloc 和 new 时，有一种轻度的紧张和惶恐的感觉时，你就具 备了这方面的修养了。 对于 malloc 和 free 的操作有以下规则： 1) 配对使用，有一个 malloc，就应该有一个 free。（C++中对应为 new 和 delete） 2) 尽量在同一层上使用，不要像上面那种，malloc 在函数中，而 free 在函数外。 最好在同一调用层上使用这两个函数。 3) malloc 分配的内存一定要初始化。free 后的指针一定要设置为 NULL。 注：虽然现在的操作系统（如：UNIX 和 Win2k/NT）都有进程内存跟踪机制，也 就是如果你有没有释放的内存，操作系统会帮你释放。但操作系统依然不会释放你 程序中所有产生了 Memory Leak 的内存，所以，最好还是你自己来做这个工作。 （有的时候不知不觉就出现 Memory Leak 了，而且在几百万行的代码中找无异于 海底捞针，Rational 有一个工具叫 Purify，可能很好的帮你检查程序中的 Memory Leak） 9、变量的初始化 -------- 接上一条，变量一定要被初始化再使用。C/C++编译器在这个方面不会像 JAVA 一 样帮你初始化，这一切都需要你自己来，如果你使用了没有初始化的变量，结果未 知。好的程序员从来都会在使用变量前初始化变量的。如： 1) 对 malloc 分配的内存进行 memset 清零操作。（可以使用 calloc 分配一块全 零的内存） 2) 对一些栈上分配的 struct 或数组进行初始化。（最好也是清零） 不过话又说回来了，初始化也会造成系统运行时间有一定的开销，所以，也不要对 所有的变量做初始化，这个也没有意义。好的程序员知道哪些变量需要初始化，哪 些则不需要。如：以下这种情况，则不需要。 char *pstr; /* 一个字符串 */ pstr = ( char* ) malloc( 50 ); if ( pstr == NULL ) exit(0); strcpy( pstr, "Hello Wrold" ); 但如果是下面一种情况，最好进行内存初始化。（指针是一个危险的东西，一定要 初始化） char **pstr; /* 一个字符串数组 */ pstr = ( char** ) malloc( 50 ); if ( pstr == NULL ) exit(0); /* 让数组中的指针都指向 NULL */ memset( pstr, 0, 50*sizeof(char*) ); 而对于全局变量，和静态变量，一定要声明时就初始化。因为你不知道它第一次会 在哪里被使用。所以使用前初始这些变量是比较不现实的，一定要在声明时就初始 化它们。如： Links *plnk = NULL; /* 对于全局变量 plnk 初始化为 NULL */ 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<1000; i++ ){ GetLocalHostName( hostname ); ... } GetLocalHostName 的意思是取得当前计算机名，在循环体中，它会被调用 1000 次 啊。这是多么的没有效率的事啊。应该把这个函数拿到循环体外，这样只调用一 次，效率得到了很大的提高。虽然，我们的编译器会进行优化，会把循环体内的不 变的东西拿到循环外面，但是，你相信所有编译器会知道哪些是不变的吗？我觉得 编译器不可靠。最好还是自己动手吧。 同样，对于常用函数中的不变量，如： GetLocalHostName(char* name) { char funcName[] = "GetLocalHostName"; sys_log( "%s begin......", funcName ); ... sys_log( "%s end......", funcName ); } 如果这是一个经常调用的函数，每次调用时都要对 funcName 进行分配内存，这个 开销很大啊。把这个变量声明成 static 吧，当函数再次被调用时，就会省去了分配 内存的开销，执行效率也很好。 13、函数名和变量名的命名 ------------ 我看到许多程序对变量名和函数名的取名很草率，特别是变量名，什么 a,b,c,aa,bb,cc，还有什么 flag1,flag2, cnt1, cnt2，这同样是一种没有"修养"的行为。 即便加上好的注释。好的变量名或是函数名，我认为应该有以下的规则： 1) 直观并且可以拼读，可望文知意，不必"解码"。 2) 名字的长度应该即要最短的长度，也要能最大限度的表达其含义。 3) 不要全部大写，也不要全部小写，应该大小写都有，如： GetLocalHostName 或是 UserAccount。 4) 可以简写，但简写得要让人明白，如：ErrorCode -> ErrCode, ServerListener -> ServLisner，UserAccount -> UsrAcct 等。 5) 为了避免全局函数和变量名字冲突，可以加上一些前缀，一般以模块简称 做为前缀。 6) 全局变量统一加一个前缀或是后缀，让人一看到这个变量就知道是全局 的。 7) 用匈牙利命名法命名函数参数，局部变量。但还是要坚持"望文生意"的原 则。 8) 与 标准 excel标准偏差excel标准偏差函数exl标准差函数国标检验抽样标准表免费下载红头文件格式标准下载 库（如：STL）或开发库（如：MFC）的命名风格保持一致。 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] <= '9' ) && ( ch[1] >= 'a' || ch[1] <= 'z' ) && ( ch[2] >= 'A' || ch[2] <= 'Z' ) ) 括号，再加上空格和换行，你的代码是不是很容易读懂了？ 18、函数参数中的 const ----------- 对于一些函数中的指针参数，如果在函数中只读，请将其用 const 修饰，这样，别 人一读到你的函数接口时，就会知道你的意图是这个参数是[in]，如果没有 const 时，参数表示[in/out]，注意函数接口中的 const 使用，利于程序的维护和避免犯一 些错误。 虽然，const 修饰的指针，如：const char* p，在 C 中一点用也没有，因为不管你的 声明是不是 const，指针的内容照样能改，因为编译器会强制转换，但是加上这样 一个说明，有利于程序的阅读和编译。因为在 C 中，修改一个 const 指针所指向的 内存时，会报一个 Warning。这会引起程序员的注意。 C++中对 const 定义的就很严格了，所以 C++中要多多的使用 const，const 的成员 函数，const 的变量，这样会对让你的代码和你的程序更加完整和易读。（关于 C++的 const 我就不多说了） 19、函数的参数个数（多了请用结构） ----------------- 函数的参数个数最好不要太多，一般来说 6 个左右就可以了，众多的函数参数会让 读代码的人一眼看上去就很头昏，而且也不利于维护。如果参数众多，还请使用结 构来传递参数。这样做有利于数据的封装和程序的简洁性。 也利于使用函数的人，因为如果你的函数个数很多，比如 12 个，调用者很容易搞 错参数的顺序和个数，而使用结构 struct 来传递参数，就可以不管参数的顺序。 而且，函数很容易被修改，如果需要给函数增加参数，不需要更改函数接口，只需 更改结构体和函数内部处理，而对于调用函数的程序来说，这个动作是透明的。 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*