编程修养.txt

《编程修养》是一篇编程人员的基础注意事项指南

编程修养 

什么是好的程序员？是不是懂得很多技术细节？还是懂底层编程？还是编程速度比较快？我觉得都不是。对于一些技术细节来说和底层的技术，只要看帮助，查资料就能找到，对于速度快，只要编得多也就熟能生巧了。 
我认为好的程序员应该有以下几方面的素质： 
　1、有专研精神，勤学善问、举一反三。 
　2、积极向上的态度，有创造性思维。 
　3、与人积极交流沟通的能力，有团队精神。 
　4、谦虚谨慎，戒骄戒燥。 
5、写出的代码质量高。包括：代码的稳定、易读、规范、易维护、专业。
这些都是程序员的修养，这里我想谈谈“编程修养”，也就是上述中的第5点。我觉得，如果我要了解一个作者，我会看他所写的小说，如果我要了解一个画家，我会看他所画的图画，如果我要了解一个工人，我会看他所做出来的产品，同样，如果我要了解一个程序员，我想首先我最想看的就是他的程序代码，程序代码可以看出一个程序员的素质和修养，程序就像一个作品，有素质有修养的程序员的作品必然是一图精美的图画，一首美妙的歌曲，一本赏心悦目的小说。 
我看过许多程序，没有注释，没有缩进，胡乱命名的变量名，等等，等等，我把这种人统称为没有修养的程序，这种程序员，是在做创造性的工作吗？不，完全就是在搞破坏，他们与其说是在编程，还不如说是在对源程序进行“加密”，这种程序员，见一个就应该开除一个，因为他编的程序所创造的价值，远远小于需要在上面进行维护的价值。 
程序员应该有程序员的修养，那怕再累，再没时间，也要对自己的程序负责。我宁可要那种动作慢，技术一般，但有良好的写程序风格的程序员，也不要那种技术强、动作快的“搞破坏”的程序员。有句话叫“字如其人”，我想从程序上也能看出一个程序员的优劣。因为，程序是程序员的作品，作品的好坏直截关系到程序员的声誉和素质。而“修养”好的程序员一定能做出好的程序和软件。 
有个成语叫“独具匠心”，意思是做什么都要做得很专业，很用心，如果你要做一个“匠”，也就是造诣高深的人，那么，从一件很简单的作品上就能看出你有没有“匠”的特性，我觉得做一个程序员不难，但要做一个“程序匠”就不简单了。编程序很简单，但编出有质量的程序就难了。 
我在这里不讨论过深的技术，我只想在一些容易让人忽略的东西上说一说，虽然这些东西可能很细微，但如果你不注意这些细微之处的话，那么他将会极大的影响你的整个软件质量，以及整个软件程的实施，所谓“千里之堤，毁于蚁穴”。 
“细微之处见真功”，真正能体现一个程序的功底恰恰在这些细微之处。 
这就是程序员的--编程修养。我总结了在用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) 空格。空格能给程序代来什么损失吗？没有，有效的利用空格可以让你的程序读进来更加赏心悦目。而不一堆表达式挤在一起。看看下面的代码： 
　　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<len;i++) if((a<?0?||a>?9?)&&(a<?a?||a>?z?)) break; 
　　 
　　我拷，这种即无空格，又无换行的程序在写什么啊？加上空格和换行吧。　　 
　　 
　　for ( i=0; i<len; i++) { 
　　　　if ( ( a < ?0? || a > ?9? ) && 
　　　　　　 ( a < ?a? || a > ?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) 
　　{ 
　　　　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、程序注释 
------ 
养成写程序注释的习惯，这是每个程序员所必须要做的工作。我看过那种几千行，却居然没有一行注释的程序。这就如同在公路上驾车却没有路标一样。用不了多久，连自己都不知道自己的意图了，还要花上几倍的时间才看明白，这种浪费别人和自己的时间的人，是最为可耻的人。 
是的，你也许会说，你会写注释，真的吗？注释的书写也能看出一个程序员的功底。一般来说你需要至少写这些地方的注释：文件的注释、函数的注释、变量的注释、算法的注释、功能块的程序注释。主要就是记录你这段程序是干什么的？你的意图是什么？你这个变量是用来做什么的？等等。 
不要以为注释好写，有一些算法是很难说或写出来的，只能意会，我承认有这种情况的时候，但你也要写出来，正好可以训练一下自己的表达能力。而表达能力正是那种闷头搞技术的技术人员最缺的，你有再高的技术，如果你表达能力不行，你的技术将不能得到充分的发挥。因为，这是一个团队的时代。 
好了，说几个注释的技术细节： 
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 errorn"); 
　　　　return FALSE; 
　　} 
其它还有许多啦，比如：socket返回的socket号，malloc返回的内存。请对这些系统调用返回的东西进行判断。 

6、if 语句对出错的处理