以文本方式查看主题 - 计算机科学论坛 (http://bbs.xml.org.cn/index.asp) -- 『 编程心得 』 (http://bbs.xml.org.cn/list.asp?boardid=42) ---- 编程修养[转帖] (http://bbs.xml.org.cn/dispbbs.asp?boardid=42&rootid=&id=25651) |
-- 作者:darkhero -- 发布时间:12/19/2005 6:45:00 PM -- 编程修养[转帖] 的确,一些细节很容易被忽视。。。 什么是好的程序员?是不是懂得很多技术细节?还是懂底层编程?还是编程速度比较快?我觉得都不是。对于一些技术细节来说和底层的技术,只要看帮助,查资料就能找到,对于速度快,只要编得多也就熟能生巧了。 我认为好的程序员应该有以下几方面的素质: 1、有专研精神,勤学善问、举一反三。 这些都是程序员的修养,这里我想谈谈"编程修养",也就是上述中的第5点。我觉得,如果我要了解一个作者,我会看他所写的小说,如果我要了解一个画家,我会看他所画的图画,如果我要了解一个工人,我会看他所做出来的产品,同样,如果我要了解一个程序员,我想首先我最想看的就是他的程序代码,程序代码可以看出一个程序员的素质和修养,程序就像一个作品,有素质有修养的程序员的作品必然是一图精美的图画,一首美妙的歌曲,一本赏心悦目的小说。 我看过许多程序,没有注释,没有缩进,胡乱命名的变量名,等等,等等,我把这种人统称为没有修养的程序,这种程序员,是在做创造性的工作吗?不,完全就是在搞破坏,他们与其说是在编程,还不如说是在对源程序进行"加密",这种程序员,见一个就应该开除一个,因为他编的程序所创造的价值,远远小于需要在上面进行维护的价值。 程序员应该有程序员的修养,那怕再累,再没时间,也要对自己的程序负责。我宁可要那种动作慢,技术一般,但有良好的写程序风格的程序员,也不要那种技术强、动作快的"搞破坏"的程序员。有句话叫"字如其人",我想从程序上也能看出一个程序员的优劣。因为,程序是程序员的作品,作品的好坏直截关系到程序员的声誉和素质。而"修养"好的程序员一定能做出好的程序和软件。 有个成语叫"独具匠心",意思是做什么都要做得很专业,很用心,如果你要做一个"匠",也就是造诣高深的人,那么,从一件很简单的作品上就能看出你有没有"匠"的特性,我觉得做一个程序员不难,但要做一个"程序匠"就不简单了。编程序很简单,但编出有质量的程序就难了。 我在这里不讨论过深的技术,我只想在一些容易让人忽略的东西上说一说,虽然这些东西可能很细微,但如果你不注意这些细微之处的话,那么他将会极大的影响你的整个软件质量,以及整个软件程的实施,所谓"千里之堤,毁于蚁穴"。 "细微之处见真功",真正能体现一个程序的功底恰恰在这些细微之处。 这就是程序员的——编程修养。我总结了在用C/C++语言(主要是C语言)进行程序写作上的三十二个"修养",通过这些,你可以写出质量高的程序,同时也会让看你程序的人渍渍称道,那些看过你程序的人一定会说:"这个人的编程修养不错"。 ———————————————————————— 01、版权和版本
1、版权和版本 对于C/C++的文件,文件头应该有类似这样的注释: 而对于函数来说,应该也有类似于这样的注释: /*================================================================ 这样的描述可以让人对一个函数,一个文件有一个总体的认识,对代码的易读性和易维护性有很大的好处。这是好的作品产生的开始。 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'9')&&(a[i]<'a'||a[i]>'z')) break; 我拷,这种即无空格,又无换行的程序在写什么啊?加上空格和换行吧。 for ( i=0; i if ( ( a[i] < '0' || a[i] > '9' ) && 好多了吧?有时候,函数参数多的时候,最好也换行,如: CreateProcess( 条件语句也应该在必要时换行: if ( ch >= '0' || ch <= '9' || HANDLE hProcess; /* open the process handle */ memset(&procInfo, 0, sizeof(procInfo)); return(0); v) 对齐。用TAB键对齐你的一些变量的声明或注释,一样会让你的程序好看一些。如: typedef struct _pt_man_t_ { 怎么样?感觉不错吧。 这里主要讲述了如果写出让人赏心悦目的代码,好看的代码会让人的心情愉快,读起代码也就不累,工整、整洁的程序代码,通常更让人欢迎,也更让人称道。现在的硬盘空间这么大,不要让你的代码挤在一起,这样它们会抱怨你虐待它们的。好了,用"缩进、空格、换行、空行、对齐"装饰你的代码吧,让他们从没有秩序的土匪中变成一排排整齐有秩序的正规部队吧。 是的,你也许会说,你会写注释,真的吗?注释的书写也能看出一个程序员的功底。一般来说你需要至少写这些地方的注释:文件的注释、函数的注释、变量的注释、算法的注释、功能块的程序注释。主要就是记录你这段程序是干什么的?你的意图是什么?你这个变量是用来做什么的?等等。 不要以为注释好写,有一些算法是很难说或写出来的,只能意会,我承认有这种情况的时候,但你也要写出来,正好可以训练一下自己的表达能力。而表达能力正是那种闷头搞技术的技术人员最缺的,你有再高的技术,如果你表达能力不行,你的技术将不能得到充分的发挥。因为,这是一个团队的时代。 好了,说几个注释的技术细节: i) 对于行注释("//")比块注释("/* */")要好的说法,我并不是很同意。因为一些老版本的C编译器并不支持行注释,所以为了你的程序的移植性,请你还是尽量使用块注释。 ii) 你也许会为块注释的不能嵌套而不爽,那么你可以用预编译来完成这个功能。使用"#if 0"和"#endif"括起来的代码,将不被编译,而且还可以嵌套。 我经常看到这样的程序: char* 不!请不要这样做。 你应该先判断一下传进来的那个指针是不是为空。如果传进来的指针为空的话,那么,你的一个大的系统就会因为这一个小的函数而崩溃。一种更好的技术是使用断言(assert),这里我就不多说这些技术细节了。当然,如果是在C++中,引用要比指针好得多,但你也需要对各个参数进行检查。 写有参数的函数时,首要工作,就是要对传进来的所有参数进行合法性检查。而对于传出的参数也应该进行检查,这个动作当然应该在函数的外部,也就是说,调用完一个函数后,应该对其传出的值进行检查。 当然,检查会浪费一点时间,但为了整个系统不至于出现"非法操作"或是"Core Dump"的系统级的错误,多花这点时间还是很值得的。 fp = fopen("log.txt", "a"); 其它还有许多啦,比如:socket返回的socket号,malloc返回的内存。请对这些系统调用返回的东西进行判断。
6、if 语句对出错的处理 这种结构很不好,特别是如果"正常处理代码"很长时,对于这种情况,最好不要用else。先判断错误,如: if ( ch < '0' || ch > '9' ){ /* 正常处理代码 */ 还是把头文件的内容都放在#ifndef和#endif中吧。不管你的头文件会不会被多个文件引用,你都要加上这个。一般格式是这样的: #ifndef <标识> ...... #endif <标识>在理论上来说可以是自由命名的,但每个头文件的这个"标识"都应该是唯一的。标识的命名规则一般是头文件名全大写,前后加下划线,并把文件名中的"."也变成下划线,如:stdio.h #ifndef _STDIO_H_ ...... #endif (BTW:预编译有多很有用的功能。你会用预编译吗?) 由malloc系统函数分配的内存就是从堆上分配内存。从堆上分配的内存一定要自己释放。用free释放,不然就是术语——"内存泄露"(或是"内存漏洞")—— Memory Leak。于是,系统的可分配内存会随malloc越来越少,直到系统崩溃。还是来看看"栈内存"和"堆内存"的差别吧。 栈内存分配 if ( len <= 0 ) return NULL; 对于第一个函数,那块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) 注:虽然现在的操作系统(如:UNIX和Win2k/NT)都有进程内存跟踪机制,也就是如果你有没有释放的内存,操作系统会帮你释放。但操作系统依然不会释放你程序中所有产生了Memory Leak的内存,所以,最好还是你自己来做这个工作。(有的时候不知不觉就出现Memory Leak了,而且在几百万行的代码中找无异于海底捞针,Rational有一个工具叫Purify,可能很好的帮你检查程序中的Memory Leak) 1) 对malloc分配的内存进行memset清零操作。(可以使用calloc分配一块全零的内存) 不过话又说回来了,初始化也会造成系统运行时间有一定的开销,所以,也不要对所有的变量做初始化,这个也没有意义。好的程序员知道哪些变量需要初始化,哪些则不需要。如:以下这种情况,则不需要。 char *pstr; /* 一个字符串 */ 但如果是下面一种情况,最好进行内存初始化。(指针是一个危险的东西,一定要初始化) char **pstr; /* 一个字符串数组 */ /* 让数组中的指针都指向NULL */ 而对于全局变量,和静态变量,一定要声明时就初始化。因为你不知道它第一次会在哪里被使用。所以使用前初始这些变量是比较不现实的,一定要在声明时就初始化它们。如: Links *plnk = NULL; /* 对于全局变量plnk初始化为NULL */ H文件和C文件最大的用处就是声明和实现分开。这个特性应该是公认的了,但我仍然看到有些人喜欢把函数写在H文件中,这种习惯很不好。(如果是C++话,对于其模板函数,在VC中只有把实现和声明都写在一个文件中,因为VC不支持export关键字)。而且,如果在H文件中写上函数的实现,你还得在makefile中把头文件的依赖关系也加上去,这个就会让你的makefile很不规范。 最后,有一个最需要注意的地方就是:带初始化的全局变量不要放在H文件中! 例如有一个处理错误信息的结构: char* errmsg[] = { 请不要把这个东西放在头文件中,因为如果你的这个头文件被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的效率高。即便是像logmsg这样频繁使用的的数据,操作系统的内存调度算法会让这样的频繁使用的页面常驻于内存,所以也就不会出现内存换页问题了。 if ( p == NULL ){ 告别学生时代的编程吧。这种编程很不利于维护和管理,出错信息或是提示信息,应该统一处理,而不是像上面这样,写成一个"硬编码"。第10条对这方面的处理做了一部分说明。如果要管理错误信息,那就要有以下的处理: /* 声明出错代码 */ /* 声明出错信息 */ /* 声明错误代码全局变量 */ /* 打印出错信息函数 */ printf("Error: %s\n", errmsg[errno] ); 这个基本上是ANSI的错误处理实现细节了,于是当你程序中有错误时你就可以这样处理: bool CheckPermission( char* userName ) ... main() 一个即有共性,也有个性的错误信息处理,这样做有利同种错误出一样的信息,统一用户界面,而不会因为文件打开失败,A程序员出一个信息,B程序员又出一个信息。而且这样做,非常容易维护。代码也易读。 当然,物极必反,也没有必要把所有的输出都放到errmsg中,抽取比较重要的出错信息或是提示信息是其关键,但即使这样,这也包括了大多数的信息。 for( i=0; i<1000; i++ ){ GetLocalHostName的意思是取得当前计算机名,在循环体中,它会被调用1000次啊。这是多么的没有效率的事啊。应该把这个函数拿到循环体外,这样只调用一次,效率得到了很大的提高。虽然,我们的编译器会进行优化,会把循环体内的不变的东西拿到循环外面,但是,你相信所有编译器会知道哪些是不变的吗?我觉得编译器不可靠。最好还是自己动手吧。 同样,对于常用函数中的不变量,如: GetLocalHostName(char* name) sys_log( "%s begin......", funcName ); 如果这是一个经常调用的函数,每次调用时都要对funcName进行分配内存,这个开销很大啊。把这个变量声明成static吧,当函数再次被调用时,就会省去了分配内存的开销,执行效率也很好。 1) 直观并且可以拼读,可望文知意,不必"解码"。 |
-- 作者:pennyliang -- 发布时间:12/20/2005 11:15:00 AM -- 写的很好,不过文中认为的修养多是在编码规范的角度,我认为还远远不止这些. 好的编码规范充其量只能算一个合格的程序员,如果上升到修养高度那么需要不断的钻研精神, 能在各种场合充分的应用专业知识解决问题,又综合考虑到环境等外界的因素,成熟,目标感强,有大局观,可靠和稳定,代码的规范得确是一个很好的反映程序员修养的方面. |
-- 作者:reallyh -- 发布时间:12/20/2005 11:23:00 AM -- 就像造房子,只能把砖头砌整齐的还是远远不够的,或者说他只是一个工匠而已! |
-- 作者:pennyliang -- 发布时间:12/20/2005 12:05:00 PM -- 斑竹果然精辟,是这个道理,要想成为大家需要多年的修炼才行。 |
-- 作者:darkhero -- 发布时间:12/21/2005 9:00:00 PM -- 同意,我是新手,大2的,请多多指教~~ ^_^ |
-- 作者:pennyliang -- 发布时间:12/21/2005 9:34:00 PM -- 不敢不敢,事实上我看过一些人写的代码,尽管完成了一些功能,或者是没有考虑到代码的内质量,比如你提到的规范性差导致的可读性差,可维护性差,经验不足导致的可修改性差,或者对问题分析的不透彻,不能彻底理解问题发生的环境导致可扩展性差,更多的是在实现的功能里面没有很好的考虑用户的需要,界面的需要,用户心里的需要,用户使用软件环境的需要,用户接收能力的需要等等。写出一个专业的程序,不是仅仅看看书就可以的,我想需要更加扎实的练习,实践,和交流。 |
-- 作者:reallyh -- 发布时间:12/21/2005 9:47:00 PM -- pennyliang要多把你的经验在这里发表啊!! |
-- 作者:xiongbajian -- 发布时间:1/11/2006 3:17:00 PM -- 不错 |
-- 作者:王小欢 -- 发布时间:5/24/2006 8:01:00 PM -- 这是程序员应该做的,也是最基本的职业道德. |
-- 作者:derman -- 发布时间:7/21/2006 1:15:00 PM -- 精辟~~ |
-- 作者:kg107 -- 发布时间:8/12/2006 3:08:00 PM -- 楼主的文对我大有启发, 谢谢了... 哈哈... |
-- 作者:michael8971 -- 发布时间:11/15/2006 4:20:00 PM -- 好帖,学习... |
-- 作者:falcon2222 -- 发布时间:5/6/2007 2:42:00 PM -- 要好好反省了`` |
W 3 C h i n a ( since 2003 ) 旗 下 站 点 苏ICP备05006046号《全国人大常委会关于维护互联网安全的决定》《计算机信息网络国际联网安全保护管理办法》 |
93.750ms |