什么是好的程序员?是不是懂得很多技术细节?还是懂底层编程?还是编程速度比较快?我觉得都不是。对于一些技术细节来说和底层的技术,只要看帮助,查资料就能找到,对于速度快,只要编得多也就熟能生巧了。 P-Su5F
NHaMo*xQ
我认为好的程序员应该有以下几方面的素质: TD,nIgH`
J|QiH<
1、有专研精神,勤学善问、举一反三。 %mI~
=^za
2、积极向上的态度,有创造性思维。 JMyTwj[7
3、与人积极交流沟通的能力,有团队精神。 f3PMVf:<
4、谦虚谨慎,戒骄戒燥。 z&+
zl6
5、写出的代码质量高。包括:代码的稳定、易读、规范、易维护、专业。 d;G~hVu
H;KDZO9W
这些都是程序员的修养,这里我想谈谈“编程修养”,也就是上述中的第5点。我觉得,如果我要了解一个作者,我会看他所写的小说,如果我要了解一个画家,我会看他所画的图画,如果我要了解一个工人,我会看他所做出来的产品,同样,如果我要了解一个程序员,我想首先我最想看的就是他的程序代码,程序代码可以看出一个程序员的素质和修养,程序就像一个作品,有素质有修养的程序员的作品必然是一图精美的图画,一首美妙的歌曲,一本赏心悦目的小说。 @Hjea1@t
8X7{vN_3K
我看过许多程序,没有注释,没有缩进,胡乱命名的变量名,等等,等等,我把这种人统称为没有修养的程序,这种程序员,是在做创造性的工作吗?不,完全就是在搞破坏,他们与其说是在编程,还不如说是在对源程序进行“加密”,这种程序员,见一个就应该开除一个,因为他编的程序所创造的价值,远远小于需要在上面进行维护的价值。 #hxyOq,
&0v.E"0<
程序员应该有程序员的修养,那怕再累,再没时间,也要对自己的程序负责。我宁可要那种动作慢,技术一般,但有良好的写程序风格的程序员,也不要那种技术强、动作快的“搞破坏”的程序员。有句话叫“字如其人”,我想从程序上也能看出一个程序员的优劣。因为,程序是程序员的作品,作品的好坏直截关系到程序员的声誉和素质。而“修养”好的程序员一定能做出好的程序和软件。 46,j9x
f_6`tq m%
有个成语叫“独具匠心”,意思是做什么都要做得很专业,很用心,如果你要做一个“匠”,也就是造诣高深的人,那么,从一件很简单的作品上就能看出你有没有“匠”的特性,我觉得做一个程序员不难,但要做一个“程序匠”就不简单了。编程序很简单,但编出有质量的程序就难了。 [*Ju3
dcq#TBo8
我在这里不讨论过深的技术,我只想在一些容易让人忽略的东西上说一说,虽然这些东西可能很细微,但如果你不注意这些细微之处的话,那么他将会极大的影响你的整个软件质量,以及整个软件程的实施,所谓“千里之堤,毁于蚁穴”。 Q~,YbZ-7
hR)2xz
“细微之处见真功”,真正能体现一个程序的功底恰恰在这些细微之处。 -- k:a$Nt
`T WN^0!]
这就是程序员的——编程修养。我总结了在用C/C++语言(主要是C语言)进行程序写作上的三十二个“修养”,通过这些,你可以写出质量高的程序,同时也会让看你程序的人渍渍称道,那些看过你程序的人一定会说:“这个人的编程修养不错”。 Dy9\O77>
<8o(CA\
———————————————————————— @LX6hm*}
j,
u#K)7{T
01、版权和版本 )pgrl
02、缩进、空格、换行、空行、对齐 45+{nN[
03、程序注释 @h?crJ6$
04、函数的[in][out]参数 zCe/Kukvy
05、对系统调用的返回进行判断 OkH\^
06、if 语句对出错的处理 grcbH
07、头文件中的#ifndef p2pAvlNoF
08、在堆上分配内存 JWHSnu!
09、变量的初始化 \2!!L=&4G
10、h和c文件的使用 ;#anZC;
11、出错信息的处理 8L{u}|{
12、常用函数和循环语句中的被计算量 r6.N4eW.L
13、函数名和变量名的命名 4\2V9F{s
14、函数的传值和传指针 |!*Xl)
]
15、修改别人程序的修养 ~!:0iFE&H
16、把相同或近乎相同的代码形成函数和宏 \L]|-f(4
17、表达式中的括号 {]/8skov5]
18、函数参数中的const wD9a#AgEd
19、函数的参数个数 H7&xLYQ2
20、函数的返回类型,不要省略 >)4YP*qIPb
21、goto语句的使用 1(gfdx9|b
22、宏的使用 8k!6b\Imz
23、static的使用 6`e@$(dfA
24、函数中的代码尺寸 }vh Za p^
25、typedef的使用 g1[&c+=U`P
26、为常量声明宏 9K"JYJ
q2
27、不要为宏定义加分号 >J>V%
7
28、||和&&的语句执行顺序 l[Z)@bC1
29、尽量用for而不是while做循环 v[ ,Src
30、请sizeof类型而不是变量 M7dU@ Ag
31、不要忽略Warning SgM.B
32、书写Debug版和Release版的程序 F:T GsV#
>- Bg%J9
v,1F--v
$|<m9CW
1、版权和版本 >S#ul?
——————— tFh|V
pB
好的程序员会给自己的每个函数,每个文件,都注上版权和版本。 a39h P*
\ V%_hl
对于C/C++的文件,文件头应该有类似这样的注释: .ER 98
/************************************************************************ N}Vn;29
* ?y%t}C\W
* 文件名:network.c fE;Q:# Z.
* 8A2z 5Aa
* 文件描述:网络通讯函数集 ">90E^
* 1/iE`Si
* 创建人: Hao Chen, 2003年2月3日 cf;Ht^M\
* AtHS@p
* 版本号:1.0 * gqSWQ
* Pv){sYUh
* 修改记录: j}WByaZ&
* hnxc`VX>g
************************************************************************/ ARB7>"
"yh Pm
而对于函数来说,应该也有类似于这样的注释: NPJ.+ph
+;gsRhWk
/*================================================================ ?pwE0N^
* ?0vNEz[
* 函 数 名:XXX AU{:;%.g
* '"xiS$b(
* 参 数: ?[= U%sPu=
* 6?gi_3g
* type name [IN] : descripts |nxdB&1n
* 8T5k-HwE
* 功能描述: e!0OW7kV
* r6Nm!Bq7
* .............. r"_Y3SxxL
* l5J.A@0
* 返 回 值:成功TRUE,失败FALSE 8LrK94
* i0Pn Z
J
* 抛出异常: |B[eJq
* ($d4:Ww
* 作 者:ChenHao 2003/4/2 Ps>&"k$T
* kC$I2[ t!
================================================================*/ |*\C{b
'}{?AUDx
这样的描述可以让人对一个函数,一个文件有一个总体的认识,对代码的易读性和易维护性有很大的好处。这是好的作品产生的开始。 u-><}OVf~
TOT
PzB
S/Oxr%H
2、缩进、空格、换行、空行、对齐 \<65??P
———————————————— H5M#q6`H6
i) 缩进应该是每个程序都会做的,只要学程序过程序就应该知道这个,但是我仍然看过不缩进的程序,或是乱缩进的程序,如果你的公司还有写程序不缩进的程序员,请毫不犹豫的开除他吧,并以破坏源码罪起诉他,还要他赔偿读过他程序的人的精神损失费。缩进,这是不成文规矩,我再重提一下吧,一个缩进一般是一个TAB键或是4个空格。(最好用TAB键) VifmZ;S@Y
MOHHZApt
ii) 空格。空格能给程序代来什么损失吗?没有,有效的利用空格可以让你的程序读进来更加赏心悦目。而不一堆表达式挤在一起。看看下面的代码: J r*"V`
X"/~4\tJ"
ha=(ha*128+*key++)%tabPtr->size; dWpk='
,"G\f1
ha = ( ha * 128 + *key++ ) % tabPtr->size; m|4LbWz
Tg''1 Wl*
有空格和没有空格的感觉不一样吧。一般来说,语句中要在各个操作符间加空格,函数调用时,要以各个参数间加空格。如下面这种加空格的和不加的: jnBC;I[:
o)I/P<
if ((hProc=OpenProcess(PROCESS_ALL_ACCESS,FALSE,pid))==NULL){ Fd8hGj1
} z7=fDe
-
>t#\&|9I
if ( ( hProc = OpenProcess(PROCESS_ALL_ACCESS, FALSE, pid) ) == NULL ){ =5s$qb?#
} 0dt"ZSm
>oY^Gx
iii) 换行。不要把语句都写在一行上,这样很不好。如: dR[o|r
^k72{ 3N(
for(i=0;i'9')&&(a<'a'||a>'z')) break; "c
Pz|~
QJXdb]Y^;
我拷,这种即无空格,又无换行的程序在写什么啊?加上空格和换行吧。 8/q*o>[?
Pj!%ym3A
for ( i=0; i if ( ( a < '0' || a > '9' ) && !S,pRS+
( a < 'a' || a > 'z' ) ) { R^tcr)(
break; fVUKvZ}P*
} L@A9{,9Pl
} s]x2DH+_
j|4tiv>
好多了吧?有时候,函数参数多的时候,最好也换行,如: L82NP)St
x#
8IZ
CreateProcess( h48 bb.p2
NULL,
8 +(c 1
cmdbuf, ^5x4 q
NULL, 5$^c@ 0
NULL, ^H!Lp[5c
bInhH, eH[y[~r
dwCrtFlags, fsI`DjKi)
envbuf, #W5Yw>$
NULL, /(zB0TEd
&siStartInfo, gKQ@!UU8
&prInfo +]L) >$6
); (Y;'[.
P>W8V+l![
条件语句也应该在必要时换行: gA+YtU{z
hht+bpHl
if ( ch >= '0' || ch <= '9' || X[{\3Av
ch >= 'a' || ch <= 'z' || <2)v9c
ch >= 'A' || ch <= 'Z' ) Y6;@ /[_
c Vg$dt
%zQ2:iT5@=
iv) 空行。不要不加空行,空行可以区分不同的程序块,程序块间,最好加上空行。如: }AAbhr9d}
Y3M','H([
HANDLE hProcess; 2Q
3/-R
PROCESS_T procInfo; :BDviUC7Z
6jtTT%>y
/* open the process handle */ AeQC:
if((hProcess = OpenProcess(PROCESS_ALL_ACCESS, FALSE, pid)) == NULL) }wL3mVz
{ !F,s"
return LSE_MISC_SYS; opnkmM&[
} MM*-i=
z1qUz7
memset(&procInfo, 0, sizeof(procInfo)); 05 g?jV
procInfo.idProc = pid; my=~"bw4
procInfo.hdProc = hProcess; vGyppm[0
procInfo.misc |= MSCAVA_PROC; #tP )-ww
cJV!>0ua
return(0); ULrbQ}"cva
qAvvXs=5
v) 对齐。用TAB键对齐你的一些变量的声明或注释,一样会让你的程序好看一些。如: u2om5e:
]E..43
typedef struct _pt_man_t_ { l~{T#Q
int numProc; /* Number of processes */ qL~Pjr>cF
int maxProc; /* Max Number of processes */ g4T3?"xMB_
int numEvnt; /* Number of events */ FJlsWh4,6=
int maxEvnt; /* Max Number of events */ {5.?'vMp
HANDLE* pHndEvnt; /* Array of events */ !g/_w
DWORD timeout; /* Time out interval */ T-!|l7V~f
HANDLE hPipe; /* Namedpipe */ pfNThMf
TCHAR usr[MAXUSR];/* User name of the process */ 4SBLu%=s%
int numMsg; /* Number of Message */ Qv=Bq{N
int Msg[MAXMSG];/* Space for intro process communicate */ dr>]+H=3E
} PT_MAN_T; cWc$yE'
]Y$&78u8t
怎么样?感觉不错吧。 o"f%\N0_8
C7T;;1P?
这里主要讲述了如果写出让人赏心悦目的代码,好看的代码会让人的心情愉快,读起代码也就不累,工整、整洁的程序代码,通常更让人欢迎,也更让人称道。现在的硬盘空间这么大,不要让你的代码挤在一起,这样它们会抱怨你虐待它们的。好了,用“缩进、空格、换行、空行、对齐”装饰你的代码吧,让他们从没有秩序的土匪中变成一排排整齐有秩序的正规部队吧。 LVWxd}0
yOM
-;h
h!~|6nj
3、程序注释 "pl[(rc+u
—————— %rX\
P
养成写程序注释的习惯,这是每个程序员所必须要做的工作。我看过那种几千行,却居然没有一行注释的程序。这就如同在公路上驾车却没有路标一样。用不了多久,连自己都不知道自己的意图了,还要花上几倍的时间才看明白,这种浪费别人和自己的时间的人,是最为可耻的人。 [L)V(o)v
]X4RnV55Q
是的,你也许会说,你会写注释,真的吗?注释的书写也能看出一个程序员的功底。一般来说你需要至少写这些地方的注释:文件的注释、函数的注释、变量的注释、算法的注释、功能块的程序注释。主要就是记录你这段程序是干什么的?你的意图是什么?你这个变量是用来做什么的?等等。 ":z@c,
ur`}v|ZY
不要以为注释好写,有一些算法是很难说或写出来的,只能意会,我承认有这种情况的时候,但你也要写出来,正好可以训练一下自己的表达能力。而表达能力正是那种闷头搞技术的技术人员最缺的,你有再高的技术,如果你表达能力不行,你的技术将不能得到充分的发挥。因为,这是一个团队的时代。 "SDsISWd
AF
QnCl Of
好了,说几个注释的技术细节: /$<JCNGv
+Hi{/{k0N
i) 对于行注释(“//”)比块注释(“/* */”)要好的说法,我并不是很同意。因为一些老版本的C编译器并不支持行注释,所以为了你的程序的移植性,请你还是尽量使用块注释。 uk1v7#p
"
gwm23Rpj
ii) 你也许会为块注释的不能嵌套而不爽,那么你可以用预编译来完成这个功能。使用“#if 0”和“#endif”括起来的代码,将不被编译,而且还可以嵌套。 0sY#MHPT&
W>VAbm
>02i8:Tp5K
4、函数的[in][out]参数 t2m ^
——————————— e4 ?<GT
?WMi S]Q\
我经常看到这样的程序: =
c/3^e
FuncName(char* str) O]4W|WI3
{ >DkN+S
int len = strlen(str); ~c9vdK
..... <w%Yq?^
} sCL/pb]
FC~|&
char* 18J.vcP
GetUserName(struct user* pUser) JJ*0M(GG
{ ^glbxbhI4
return pUser->name; 1h&)I%`?
} )moo?Q
Py}!C@e
不!请不要这样做。 \qRjXadj
nqUH6(
你应该先判断一下传进来的那个指针是不是为空。如果传进来的指针为空的话,那么,你的一个大的系统就会因为这一个小的函数而崩溃。一种更好的技术是使用断言(assert),这里我就不多说这些技术细节了。当然,如果是在C++中,引用要比指针好得多,但你也需要对各个参数进行检查。 #r-j.f}yx
0 [*nAo
写有参数的函数时,首要工作,就是要对传进来的所有参数进行合法性检查。而对于传出的参数也应该进行检查,这个动作当然应该在函数的外部,也就是说,调用完一个函数后,应该对其传出的值进行检查。 38OIFT
Z={UM/6w
当然,检查会浪费一点时间,但为了整个系统不至于出现“非法操作”或是“Core Dump”的系统级的错误,多花这点时间还是很值得的。 wV]sGHu F}
Z&BM%.NZJ
X*43!\
5、对系统调用的返回进行判断 !Q<8c =f
—————————————— !tm|A`<g#<
继续上一条,对于一些系统调用,比如打开文件,我经常看到,许多程序员对fopen返回的指针不做任何判断,就直接使用了。然后发现文件的内容怎么也读出不,或是怎么也写不进去。还是判断一下吧: tP/GDC;
cob9hj#&7
fp = fopen("log.txt", "a"); a-SB1-5jf
if ( fp == NULL ){ {^2({A#&
printf("Error: open file error\n"); 4UkP:Vz:
return FALSE; zDKLo 3:
} )^V5*#69D
E5v|SFD
其它还有许多啦,比如:socket返回的socket号,malloc返回的内存。请对这些系统调用返回的东西进行判断。 j&o/X7I=
6、if 语句对出错的处理 l;"ub^AH
——————————— pIM*c6
我看见你说了,这有什么好说的。还是先看一段程序代码吧。 Oct\He\.
if ( ch >= '0' && ch <= '9' ){ 8HHgN`_
/* 正常处理代码 */ ksxO<Y
}else{ 'Hcd&3a
/* 输出错误信息 */ H@ 1[SKBl
printf("error ......\n"); kG_&-b
return ( FALSE ); KE&InTM/j
} tr#)iZ\
?Xy w<fMQ
这种结构很不好,特别是如果“正常处理代码”很长时,对于这种情况,最好不要用else。先判断错误,如: @$K![]oD
;7B2~zL
if ( ch < '0' || ch > '9' ){ l{B<"+8
/* 输出错误信息 */ 'd~, o[x
printf("error ......\n"); 2_B;
return ( FALSE ); ZlwcwoPib
} vr8J*36{
<yX@@8
/* 正常处理代码 */ h$:&1jVY{
...... }0(vR_x
FE^?U%:u@
D0,oml
这样的结构,不是很清楚吗?突出了错误的条件,让别人在使用你的函数的时候,第一眼就能看到不合法的条件,于是就会更下意识的避免。 [rD+8,zVm
kM6
EZ`mj
SF78s:_!_
7、头文件中的#ifndef H>@JfYZ0
—————————— "!w[U{
千万不要忽略了头件的中的#ifndef,这是一个很关键的东西。比如你有两个C文件,这两个C文件都include了同一个头文件。而编译时,这两个C文件要一同编译成一个可运行文件,于是问题来了,大量的声明冲突。 1+.y,}F6b
* wQZ'
还是把头文件的内容都放在#ifndef和#endif中吧。不管你的头文件会不会被多个文件引用,你都要加上这个。一般格式是这样的: q/aL8V<"z
{HE.mHy
#ifndef <标识> KU8Cl>5
#define <标识> ;
HR\R
A[wxa
...... g&5pfrC [
...... _s*uF_:3
hx2!YNx !
#endif Wr}a\}R
&?uzJx~
<标识>在理论上来说可以是自由命名的,但每个头文件的这个“标识”都应该是唯一的。标识的命名规则一般是头文件名全大写,前后加下划线,并把文件名中的“.”也变成下划线,如:stdio.h s\n,Z?m
yE!7`c.[u
#ifndef _STDIO_H_ b ?=
#define _STDIO_H_ gFH;bZU
V2<k0@y
...... =~(L JPo6
yF [@W<
#endif H/ B^N,oi
CC]@`R5
(BTW:预编译有多很有用的功能。你会用预编译吗?) "pKGUM
"' i [~
UJyiRP:#]>
8、在堆上分配内存 yA`]%U((
————————— [1[[$ Dr
可能许多人对内存分配上的“栈 stack”和“堆 heap”还不是很明白。包括一些科班出身的人也不明白这两个概念。我不想过多的说这两个东西。简单的来讲,stack上分配的内存系统自动释放,heap上分配的内存,系统不释放,哪怕程序退出,那一块内存还是在那里。stack一般是静态分配内存,heap上一般是动态分配内存。 <_FF~lj
;Wp`th!F
由malloc系统函数分配的内存就是从堆上分配内存。从堆上分配的内存一定要自己释放。用free释放,不然就是术语——“内存泄露”(或是“内存漏洞”)—— Memory Leak。于是,系统的可分配内存会随malloc越来越少,直到系统崩溃。还是来看看“栈内存”和“堆内存”的差别吧。 5p(t")
P(W\aLp
栈内存分配 AyI}LQm]u
————— S^sW.(I
char* (p#;6Xhf
AllocStrFromStack() ?8aWUgl
{ R'$ T6FB5
char pstr[100]; ` wsMybe#
return pstr; tpy:o(H
} ?\/dfK:!
[{d[f|
njx\$,ruN
堆内存分配 O#89M%
————— VN55!l'OV
char* rg]A_(3Bb
AllocStrFromHeap(int len) -`ys pE0?
{ 1 _:1/~R1
char *pstr; rym\5
`)
L_CEY
if ( len <= 0 ) return NULL; XxrO:$
return ( char* ) malloc( len ); NVM2\fs
} 75BOiX
D9pxe qf+=
对于第一个函数,那块pstr的内存在函数返回时就被系统释放了。于是所返回的char*什么也没有。而对于第二个函数,是从堆上分配内存,所以哪怕是程序退出时,也不释放,所以第二个函数的返回的内存没有问题,可以被使用。但一定要调用free释放,不然就是Memory Leak! DIcyXZH<
*U[Q =w
在堆上分配内存很容易造成内存泄漏,这是C/C++的最大的“克星”,如果你的程序要稳定,那么就不要出现Memory Leak。所以,我还是要在这里千叮咛万嘱付,在使用malloc系统函数(包括calloc,realloc)时千万要小心。 PrYWha=c-
bNPjefBF
记得有一个UNIX上的服务应用程序,大约有几百的C文件编译而成,运行测试良好,等使用时,每隔三个月系统就是down一次,搞得许多人焦头烂额,查不出问题所在。只好,每隔两个月人工手动重启系统一次。出现这种问题就是Memery Leak在做怪了,在C/C++中这种问题总是会发生,所以你一定要小心。一个Rational的检测工作——Purify,可以帮你测试你的程序有没有内存泄漏。 VIlQzM;%^
)jQe K
我保证,做过许多C/C++的工程的程序员,都会对malloc或是new有些感冒。当你什么时候在使用malloc和new时,有一种轻度的紧张和惶恐的感觉时,你就具备了这方面的修养了。
.ubbNp_LU
?28G6T]/?d
对于malloc和free的操作有以下规则: f<t*#]<