什么是好的程序员?是不是懂得很多技术细节?还是懂底层编程?还是编程速度比较快?我觉得都不是。对于一些技术细节来说和底层的技术,只要看帮助,查资料就能找到,对于速度快,只要编得多也就熟能生巧了。 a(ITv roM/
$ ]#WC\Hv
我认为好的程序员应该有以下几方面的素质: As`=K$^Il.
CH;U_b
1、有专研精神,勤学善问、举一反三。 r\Yh'cRW{
2、积极向上的态度,有创造性思维。
KLE)+|
3、与人积极交流沟通的能力,有团队精神。 \iP@|ay9
4、谦虚谨慎,戒骄戒燥。 c %Cbq0+2
5、写出的代码质量高。包括:代码的稳定、易读、规范、易维护、专业。 HEIg_6sb
*f`P7q*
这些都是程序员的修养,这里我想谈谈“编程修养”,也就是上述中的第5点。我觉得,如果我要了解一个作者,我会看他所写的小说,如果我要了解一个画家,我会看他所画的图画,如果我要了解一个工人,我会看他所做出来的产品,同样,如果我要了解一个程序员,我想首先我最想看的就是他的程序代码,程序代码可以看出一个程序员的素质和修养,程序就像一个作品,有素质有修养的程序员的作品必然是一图精美的图画,一首美妙的歌曲,一本赏心悦目的小说。 \g
h |G
_L$a[zH
我看过许多程序,没有注释,没有缩进,胡乱命名的变量名,等等,等等,我把这种人统称为没有修养的程序,这种程序员,是在做创造性的工作吗?不,完全就是在搞破坏,他们与其说是在编程,还不如说是在对源程序进行“加密”,这种程序员,见一个就应该开除一个,因为他编的程序所创造的价值,远远小于需要在上面进行维护的价值。 QCE7VV1Rw
0Oc?:R'$
程序员应该有程序员的修养,那怕再累,再没时间,也要对自己的程序负责。我宁可要那种动作慢,技术一般,但有良好的写程序风格的程序员,也不要那种技术强、动作快的“搞破坏”的程序员。有句话叫“字如其人”,我想从程序上也能看出一个程序员的优劣。因为,程序是程序员的作品,作品的好坏直截关系到程序员的声誉和素质。而“修养”好的程序员一定能做出好的程序和软件。 $(]nl%<Q
X{OWDy
有个成语叫“独具匠心”,意思是做什么都要做得很专业,很用心,如果你要做一个“匠”,也就是造诣高深的人,那么,从一件很简单的作品上就能看出你有没有“匠”的特性,我觉得做一个程序员不难,但要做一个“程序匠”就不简单了。编程序很简单,但编出有质量的程序就难了。 ws^Ne30 R
' VKD$q
我在这里不讨论过深的技术,我只想在一些容易让人忽略的东西上说一说,虽然这些东西可能很细微,但如果你不注意这些细微之处的话,那么他将会极大的影响你的整个软件质量,以及整个软件程的实施,所谓“千里之堤,毁于蚁穴”。 :."oWqb)
:Jv5Flxl
“细微之处见真功”,真正能体现一个程序的功底恰恰在这些细微之处。 />/e
~(kqq#=s
这就是程序员的——编程修养。我总结了在用C/C++语言(主要是C语言)进行程序写作上的三十二个“修养”,通过这些,你可以写出质量高的程序,同时也会让看你程序的人渍渍称道,那些看过你程序的人一定会说:“这个人的编程修养不错”。 nJ
xO.wWE
]dI^
S
———————————————————————— &>E gKL
d!YP{y P
01、版权和版本 X0$q!
02、缩进、空格、换行、空行、对齐 v+W'0ymbnV
03、程序注释 J p+'"a
04、函数的[in][out]参数 NRx I?v
05、对系统调用的返回进行判断 -)VjjKz]8
06、if 语句对出错的处理 Lhe&
07、头文件中的#ifndef y_=y%
08、在堆上分配内存 =!xX{o?64
09、变量的初始化 q CYu@Ho
10、h和c文件的使用 wWiYxBeN
11、出错信息的处理 PPIO<K 3`
12、常用函数和循环语句中的被计算量 $?bD55
13、函数名和变量名的命名 kLZVTVSJt
14、函数的传值和传指针 ]+W){W=ai
15、修改别人程序的修养 V
K 7
16、把相同或近乎相同的代码形成函数和宏 ,w H~.LHi
17、表达式中的括号 F P|cA^$<
18、函数参数中的const $D#h, `
19、函数的参数个数 Ve&_NVPrd
20、函数的返回类型,不要省略 [H>u'fy:C
21、goto语句的使用 'wG1un;t
22、宏的使用 wlaPE8Gc
23、static的使用 31a lQ\TH
24、函数中的代码尺寸 r]Wt! oHm5
25、typedef的使用 {7z]+ h
26、为常量声明宏 Rqp#-04*W
27、不要为宏定义加分号 >RAg63!`
28、||和&&的语句执行顺序 #~"IlBk\
29、尽量用for而不是while做循环 ,_Bn{T=U
30、请sizeof类型而不是变量 MJ1qU}+]
31、不要忽略Warning X.k8w\~
32、书写Debug版和Release版的程序 V<jj'dZfW
J&,hC%]
H>+])~#
/pPH D]
1、版权和版本 ,)#rD9ZnC
——————— ,}gJY^X+
好的程序员会给自己的每个函数,每个文件,都注上版权和版本。 \&;y:4&l8
Y$A2{RjRq
对于C/C++的文件,文件头应该有类似这样的注释: ng!cK<p
/************************************************************************ i\ X3t5
* +KIz#uqF8Z
* 文件名:network.c 85q/|9D
* YRX^fZ-b
* 文件描述:网络通讯函数集 Td'(RV
* }RI_k&;
* 创建人: Hao Chen, 2003年2月3日 ,.cR @5qI
* _G/R;N71
* 版本号:1.0 UNa"\
* [Tp?u8$p`
* 修改记录: Zja3HGL
* Af]zv~uM
************************************************************************/ }3X/"2SW^
n-cI~Ax+4
而对于函数来说,应该也有类似于这样的注释: `hkvxt
O& Sk}^
/*================================================================ $jE<n/8
* d4;$=P
* 函 数 名:XXX QhJN/v
* A+* lV*@0
* 参 数: Mh-"B([Z
* 8xgBNQdPT
* type name [IN] : descripts jc
Mn
* }%/mPbd#
* 功能描述: XNJZ~Mowb
* _uMG?Sbx
* .............. m[v0mXE
* klT?h[I!
* 返 回 值:成功TRUE,失败FALSE W6NhJ#M7
* f^B8!EY#:
* 抛出异常: &|GH@^)@
* M=pQx$%a
* 作 者:ChenHao 2003/4/2
S
W%>8
* -@"3`uv"
================================================================*/ [+dCA
O@a OKk
这样的描述可以让人对一个函数,一个文件有一个总体的认识,对代码的易读性和易维护性有很大的好处。这是好的作品产生的开始。 ~Dq-q6-@t
)LFbz#;Y
I!*P' {lh
2、缩进、空格、换行、空行、对齐 B]G2P`sN
———————————————— "gM!/<~
i) 缩进应该是每个程序都会做的,只要学程序过程序就应该知道这个,但是我仍然看过不缩进的程序,或是乱缩进的程序,如果你的公司还有写程序不缩进的程序员,请毫不犹豫的开除他吧,并以破坏源码罪起诉他,还要他赔偿读过他程序的人的精神损失费。缩进,这是不成文规矩,我再重提一下吧,一个缩进一般是一个TAB键或是4个空格。(最好用TAB键) scH61Y8`
|nx3x
ii) 空格。空格能给程序代来什么损失吗?没有,有效的利用空格可以让你的程序读进来更加赏心悦目。而不一堆表达式挤在一起。看看下面的代码: MLHCBRi
Sc>mw
ha=(ha*128+*key++)%tabPtr->size; K
$- *
IeYNTk&<
ha = ( ha * 128 + *key++ ) % tabPtr->size; g]?pY
zl:by?
有空格和没有空格的感觉不一样吧。一般来说,语句中要在各个操作符间加空格,函数调用时,要以各个参数间加空格。如下面这种加空格的和不加的: `J,>#Y6(J
>:6iFPP
if ((hProc=OpenProcess(PROCESS_ALL_ACCESS,FALSE,pid))==NULL){ yC\UT
~j/
} z.-yL,Rc`-
<PDCM8
if ( ( hProc = OpenProcess(PROCESS_ALL_ACCESS, FALSE, pid) ) == NULL ){ !?JZ^/u
} pS+w4gW
?;~E*kzO&
iii) 换行。不要把语句都写在一行上,这样很不好。如: oLKliA=q
M^:JhX{
for(i=0;i'9')&&(a<'a'||a>'z')) break; !\R5/-_UU
e3SnC:OWf
我拷,这种即无空格,又无换行的程序在写什么啊?加上空格和换行吧。 Az:~|P
5WHz_'c
for ( i=0; i if ( ( a < '0' || a > '9' ) && zU&Iy_Ke.
( a < 'a' || a > 'z' ) ) { q@bye4Ry%W
break; 'fU #v`i
} p-.kBF
} O^8ZnN_+
U?Jk
好多了吧?有时候,函数参数多的时候,最好也换行,如: Gkuqe3
e7;7TrB.
CreateProcess( lu"0\}7X
NULL, I#(lxlp"Ho
cmdbuf, <?7qI8 5OT
NULL, IsI5c
NULL, Eu(QeST\
bInhH, U|Fqna
dwCrtFlags, v3Vve:}+
envbuf, 3xs<w7
NULL, }jCO@v;
&siStartInfo, i;^lh]u
&prInfo +=E\sEe
); \KhcNr?ja=
Zo&i0%S\E
条件语句也应该在必要时换行: qG;tD>jy
#G]IEO$M6
if ( ch >= '0' || ch <= '9' || 5eff3qrH{
ch >= 'a' || ch <= 'z' || p"%D/-%Gu
ch >= 'A' || ch <= 'Z' ) vEg%ivj3
0QZT<Zs
zJw5+
+
iv) 空行。不要不加空行,空行可以区分不同的程序块,程序块间,最好加上空行。如: pmB
{b
0(-4"u>?
HANDLE hProcess; CHKhJ v3+4
PROCESS_T procInfo; t~o"x .
.ifz9jM'
/* open the process handle */ NuR7pjNMZ
if((hProcess = OpenProcess(PROCESS_ALL_ACCESS, FALSE, pid)) == NULL) :38{YCN
{ `qs,V
return LSE_MISC_SYS; ^>l <)$s
} S~aWun
K-k!':K:
memset(&procInfo, 0, sizeof(procInfo)); B3ItZojAuw
procInfo.idProc = pid; V>QyiB
procInfo.hdProc = hProcess; Vt}QPNt
procInfo.misc |= MSCAVA_PROC; @h|qL-:!vG
ASbIc"S6
return(0); ]`$yY5 &W0
h s',f
v) 对齐。用TAB键对齐你的一些变量的声明或注释,一样会让你的程序好看一些。如: vz4(
k/
B.G6vx4yp
typedef struct _pt_man_t_ { s>6h]H
int numProc; /* Number of processes */ HN5661;8
int maxProc; /* Max Number of processes */ uluAqDz`
int numEvnt; /* Number of events */ pCIS82L
int maxEvnt; /* Max Number of events */ @)h>vg
HANDLE* pHndEvnt; /* Array of events */ Yg.[R]
UC
DWORD timeout; /* Time out interval */ $4g{4-)
HANDLE hPipe; /* Namedpipe */ o^2MfFS
TCHAR usr[MAXUSR];/* User name of the process */ Yt#;
+*d5
int numMsg; /* Number of Message */ F0_w9"3E~
int Msg[MAXMSG];/* Space for intro process communicate */ x[{\Aw>$.
} PT_MAN_T; V _~lME
&q<k0_5Q
怎么样?感觉不错吧。 Nksm&{=6S
-b^dK)wR~
这里主要讲述了如果写出让人赏心悦目的代码,好看的代码会让人的心情愉快,读起代码也就不累,工整、整洁的程序代码,通常更让人欢迎,也更让人称道。现在的硬盘空间这么大,不要让你的代码挤在一起,这样它们会抱怨你虐待它们的。好了,用“缩进、空格、换行、空行、对齐”装饰你的代码吧,让他们从没有秩序的土匪中变成一排排整齐有秩序的正规部队吧。 >}
2C,8N
ys=}
V|
bfA>kn0C
3、程序注释 Qg/FFn^Kg*
—————— j<kW+Iio
养成写程序注释的习惯,这是每个程序员所必须要做的工作。我看过那种几千行,却居然没有一行注释的程序。这就如同在公路上驾车却没有路标一样。用不了多久,连自己都不知道自己的意图了,还要花上几倍的时间才看明白,这种浪费别人和自己的时间的人,是最为可耻的人。 Am*IC?@tq
B%\&Q@X
是的,你也许会说,你会写注释,真的吗?注释的书写也能看出一个程序员的功底。一般来说你需要至少写这些地方的注释:文件的注释、函数的注释、变量的注释、算法的注释、功能块的程序注释。主要就是记录你这段程序是干什么的?你的意图是什么?你这个变量是用来做什么的?等等。 htbE
Q NW
I;'{X_9$a
不要以为注释好写,有一些算法是很难说或写出来的,只能意会,我承认有这种情况的时候,但你也要写出来,正好可以训练一下自己的表达能力。而表达能力正是那种闷头搞技术的技术人员最缺的,你有再高的技术,如果你表达能力不行,你的技术将不能得到充分的发挥。因为,这是一个团队的时代。 tR>zBh_b
i24k
]F
好了,说几个注释的技术细节: W_M#Gi/AL
X\;:aRDS
i) 对于行注释(“//”)比块注释(“/* */”)要好的说法,我并不是很同意。因为一些老版本的C编译器并不支持行注释,所以为了你的程序的移植性,请你还是尽量使用块注释。 l-%] f]>
rgIWM"
ii) 你也许会为块注释的不能嵌套而不爽,那么你可以用预编译来完成这个功能。使用“#if 0”和“#endif”括起来的代码,将不被编译,而且还可以嵌套。 tNFw1&
8B*(P>
n{TWdC
4、函数的[in][out]参数 o~XK*f=(
——————————— JY CMW!~
];w}?LFb
我经常看到这样的程序: >Gpq{Ph[
FuncName(char* str) 4q] 6[/
{ -/?)0E
int len = strlen(str); gNW+Dq|X%
..... q~9-A+n
} QtnNc!,n
[voZ=+/
char* _3 3 b %
GetUserName(struct user* pUser) b_ TI_
{ ljK?2z>
return pUser->name; W2X`%Tx0
} "Y<;R+z
W|8VE,"7
不!请不要这样做。 Q8`V0E\~
)$TN%hV!
你应该先判断一下传进来的那个指针是不是为空。如果传进来的指针为空的话,那么,你的一个大的系统就会因为这一个小的函数而崩溃。一种更好的技术是使用断言(assert),这里我就不多说这些技术细节了。当然,如果是在C++中,引用要比指针好得多,但你也需要对各个参数进行检查。 \Vx^u}3O
2p, U ^h
写有参数的函数时,首要工作,就是要对传进来的所有参数进行合法性检查。而对于传出的参数也应该进行检查,这个动作当然应该在函数的外部,也就是说,调用完一个函数后,应该对其传出的值进行检查。 nlB'@r
f>6{tI5X
当然,检查会浪费一点时间,但为了整个系统不至于出现“非法操作”或是“Core Dump”的系统级的错误,多花这点时间还是很值得的。 SWzqCF
{*+J`H_G2a
zn-=mk;W
5、对系统调用的返回进行判断 ~NIhS!
—————————————— CqEbQ>?
继续上一条,对于一些系统调用,比如打开文件,我经常看到,许多程序员对fopen返回的指针不做任何判断,就直接使用了。然后发现文件的内容怎么也读出不,或是怎么也写不进去。还是判断一下吧: &fB=&jc*j
GPLop/6
fp = fopen("log.txt", "a"); }iKjef#J
if ( fp == NULL ){ ~B{08%|oK
printf("Error: open file error\n"); 8D)1ZUx7`
return FALSE; %/I:r7UR{
} By@65KmR"
;7s^slVzF
其它还有许多啦,比如:socket返回的socket号,malloc返回的内存。请对这些系统调用返回的东西进行判断。 AI3x,rk#
6、if 语句对出错的处理
;wMu
——————————— eQuw uT
我看见你说了,这有什么好说的。还是先看一段程序代码吧。 %mss{p!d6
if ( ch >= '0' && ch <= '9' ){ 4k^P1
/* 正常处理代码 */ [w<_Wj
}else{ %"r9;^bj&<
/* 输出错误信息 */ M#4;y,n<k
printf("error ......\n"); w ?_8OJ
return ( FALSE ); v`K%dBa
} 8gNTW7W/
goiI*"6M
这种结构很不好,特别是如果“正常处理代码”很长时,对于这种情况,最好不要用else。先判断错误,如: IoOOS5a
/(8"]f/
if ( ch < '0' || ch > '9' ){ 4eB'mPor
/* 输出错误信息 */ 2?7ID~\
printf("error ......\n"); K@=u F1?
return ( FALSE ); 9BZ B1oX
} X[.%[G|oj}
*~P| ? D'
/* 正常处理代码 */ ~OX\R"aZBW
...... !k%
PP
o}r_+\n
+#wVe
这样的结构,不是很清楚吗?突出了错误的条件,让别人在使用你的函数的时候,第一眼就能看到不合法的条件,于是就会更下意识的避免。 ?n{m2.H
"=DQ { (L
WwsNAJ
7、头文件中的#ifndef 3\RD%[}
—————————— ;O)*!yA(GG
千万不要忽略了头件的中的#ifndef,这是一个很关键的东西。比如你有两个C文件,这两个C文件都include了同一个头文件。而编译时,这两个C文件要一同编译成一个可运行文件,于是问题来了,大量的声明冲突。 e^N~)Nlj
kAp#6->(q
还是把头文件的内容都放在#ifndef和#endif中吧。不管你的头文件会不会被多个文件引用,你都要加上这个。一般格式是这样的: v CsE|eMP
xKE=$SV(
#ifndef <标识> !B Pm{_C
#define <标识> H^kOwmSzh
O$,
...... hkl0N%[
...... r rfJs
f4pIF"U9>
#endif ?J2A.x5`a
=LLpJ+
<标识>在理论上来说可以是自由命名的,但每个头文件的这个“标识”都应该是唯一的。标识的命名规则一般是头文件名全大写,前后加下划线,并把文件名中的“.”也变成下划线,如:stdio.h V/xXW=
fUf1G{4
#ifndef _STDIO_H_ %iNgHoH
#define _STDIO_H_ ZhCd**
90uXJyW;d
...... >[wxZ5))
EoutB Vm
#endif `\(co;:
4~1b
(BTW:预编译有多很有用的功能。你会用预编译吗?) yg8= G vO
}JtcAuQt
M{orw;1Isy
8、在堆上分配内存
yHE\Q
————————— j xI;clr
可能许多人对内存分配上的“栈 stack”和“堆 heap”还不是很明白。包括一些科班出身的人也不明白这两个概念。我不想过多的说这两个东西。简单的来讲,stack上分配的内存系统自动释放,heap上分配的内存,系统不释放,哪怕程序退出,那一块内存还是在那里。stack一般是静态分配内存,heap上一般是动态分配内存。 Ju#j%!
rF[-4t
%
由malloc系统函数分配的内存就是从堆上分配内存。从堆上分配的内存一定要自己释放。用free释放,不然就是术语——“内存泄露”(或是“内存漏洞”)—— Memory Leak。于是,系统的可分配内存会随malloc越来越少,直到系统崩溃。还是来看看“栈内存”和“堆内存”的差别吧。 c*\i%I#f2
j7E;\AZ^
栈内存分配 GmNCw5F
————— >x%HqP#_V
char* (7<G1$:z=
AllocStrFromStack() {i=V:$_#
{ \y271}'
char pstr[100]; #f(tzPD
return pstr; T\Xf0|y
} 8Ys)q x>7'
}.D18bE(
>|RoLV
堆内存分配 MzB.Vvsy%9
————— <LH6my
char* \YJQN3^46>
AllocStrFromHeap(int len) &;?+ ^L>
{ tH; 6Mp;f
char *pstr; 8aHE=x/TL
u= dj3q
if ( len <= 0 ) return NULL; &b