什么是好的程序员?是不是懂得很多技术细节?还是懂底层编程?还是编程速度比较快?我觉得都不是。对于一些技术细节来说和底层的技术,只要看帮助,查资料就能找到,对于速度快,只要编得多也就熟能生巧了。 }b6ja y
GW.s\8w
我认为好的程序员应该有以下几方面的素质: ) ,*&rd!
A+;]# 1y(D
1、有专研精神,勤学善问、举一反三。 Gh42qar`
2、积极向上的态度,有创造性思维。 1c?,= ;>
3、与人积极交流沟通的能力,有团队精神。 cZ^$!0
4、谦虚谨慎,戒骄戒燥。 +w GE
5、写出的代码质量高。包括:代码的稳定、易读、规范、易维护、专业。 0+cRUH9Ew
]O&TU X@)
这些都是程序员的修养,这里我想谈谈“编程修养”,也就是上述中的第5点。我觉得,如果我要了解一个作者,我会看他所写的小说,如果我要了解一个画家,我会看他所画的图画,如果我要了解一个工人,我会看他所做出来的产品,同样,如果我要了解一个程序员,我想首先我最想看的就是他的程序代码,程序代码可以看出一个程序员的素质和修养,程序就像一个作品,有素质有修养的程序员的作品必然是一图精美的图画,一首美妙的歌曲,一本赏心悦目的小说。 qX-Jpi P
hMi!H.EX.
我看过许多程序,没有注释,没有缩进,胡乱命名的变量名,等等,等等,我把这种人统称为没有修养的程序,这种程序员,是在做创造性的工作吗?不,完全就是在搞破坏,他们与其说是在编程,还不如说是在对源程序进行“加密”,这种程序员,见一个就应该开除一个,因为他编的程序所创造的价值,远远小于需要在上面进行维护的价值。 f-4<W0%
T5W r;a
程序员应该有程序员的修养,那怕再累,再没时间,也要对自己的程序负责。我宁可要那种动作慢,技术一般,但有良好的写程序风格的程序员,也不要那种技术强、动作快的“搞破坏”的程序员。有句话叫“字如其人”,我想从程序上也能看出一个程序员的优劣。因为,程序是程序员的作品,作品的好坏直截关系到程序员的声誉和素质。而“修养”好的程序员一定能做出好的程序和软件。 IxgnZX4N
K6!`b(
v#
有个成语叫“独具匠心”,意思是做什么都要做得很专业,很用心,如果你要做一个“匠”,也就是造诣高深的人,那么,从一件很简单的作品上就能看出你有没有“匠”的特性,我觉得做一个程序员不难,但要做一个“程序匠”就不简单了。编程序很简单,但编出有质量的程序就难了。 |$7!u DU8
-D{~7&
我在这里不讨论过深的技术,我只想在一些容易让人忽略的东西上说一说,虽然这些东西可能很细微,但如果你不注意这些细微之处的话,那么他将会极大的影响你的整个软件质量,以及整个软件程的实施,所谓“千里之堤,毁于蚁穴”。
`^F'af
>.J68x
“细微之处见真功”,真正能体现一个程序的功底恰恰在这些细微之处。 <[l2 ]"Q
CaZEU(i
这就是程序员的——编程修养。我总结了在用C/C++语言(主要是C语言)进行程序写作上的三十二个“修养”,通过这些,你可以写出质量高的程序,同时也会让看你程序的人渍渍称道,那些看过你程序的人一定会说:“这个人的编程修养不错”。 C+-~Gmrb(7
VY~WkSi[<
———————————————————————— FW[<;$
L-G186B$r
01、版权和版本 KJcdX9x
02、缩进、空格、换行、空行、对齐 8=)Aksu
03、程序注释 P#rwYPww\
04、函数的[in][out]参数 q0DoR@
05、对系统调用的返回进行判断 w?<:`
06、if 语句对出错的处理 &AOw(?2
07、头文件中的#ifndef P%B1dRa
08、在堆上分配内存 r`wL_>"{n
09、变量的初始化 sR?_ {rQ
10、h和c文件的使用 Y6^lKw
11、出错信息的处理 (WN 'wp
12、常用函数和循环语句中的被计算量 >2>xr"
13、函数名和变量名的命名
w&:h^u
14、函数的传值和传指针 >\(Ma3S
15、修改别人程序的修养 ,7/un8:%c
16、把相同或近乎相同的代码形成函数和宏 jwAO{.}T1r
17、表达式中的括号 gh i!4
18、函数参数中的const B:+}^=
19、函数的参数个数 }u:^ Mz
20、函数的返回类型,不要省略 dpE\eXoa,
21、goto语句的使用 {&w%3
22、宏的使用 }wj*^>*
23、static的使用 )k29mqa`
24、函数中的代码尺寸 #; }IHAR
25、typedef的使用 V/>SjUNq
26、为常量声明宏 v`x~O+
27、不要为宏定义加分号 ^/Gjk
28、||和&&的语句执行顺序 Mk,8v],-Tj
29、尽量用for而不是while做循环 kDO6:sjR7
30、请sizeof类型而不是变量 fbo64$!hZ
31、不要忽略Warning C'7W50b
32、书写Debug版和Release版的程序 :qgdn,Me
6TPcG d Z
,FS iE\
SuGlNp>#qm
1、版权和版本 Q+dBSKSK
——————— bs%]xf
~D;
好的程序员会给自己的每个函数,每个文件,都注上版权和版本。 69yTGUG3
'{6`n5:e
对于C/C++的文件,文件头应该有类似这样的注释: Wu.od|t0
/************************************************************************ If!0w
;h
* =p&6A^
* 文件名:network.c Er{[83
* CdTmL{Y1
* 文件描述:网络通讯函数集 `2r21rVntf
* t$Irr*
* 创建人: Hao Chen, 2003年2月3日 B>a`mFM
* .7E-
* 版本号:1.0 >{Lfrc1
* #J^p,6
* 修改记录: D|9B1>A,m
* y^M'&@F
************************************************************************/ Y5ebpw+B-
pok,`yW\
而对于函数来说,应该也有类似于这样的注释: *;"^b\f5_
0#Rj[J;kh
/*================================================================ zS?i@e
$
* :CK,(?t
* 函 数 名:XXX pklcRrx,a
* b'vJPv~hI
* 参 数: Nmi#$K[x
* }1;Ie0l=_e
* type name [IN] : descripts #)cRD#0
* hn!$?Vo.
* 功能描述: 5:n&G[Md
* sPc\xY
* .............. \hNMTj#O
* >]C;sP
* 返 回 值:成功TRUE,失败FALSE -!;vX
@
* _;LHC;,:
* 抛出异常: b2p<!?
* DB?_E{y]
* 作 者:ChenHao 2003/4/2 :p8JO:g9
* ?7a<V+V:
================================================================*/ C .YtjLQP$
rw+0<r3|K
这样的描述可以让人对一个函数,一个文件有一个总体的认识,对代码的易读性和易维护性有很大的好处。这是好的作品产生的开始。 nR"k%$
.fD k5uo
QfwGf,0p
2、缩进、空格、换行、空行、对齐 3P-#NL
———————————————— r=@h}TKv{I
i) 缩进应该是每个程序都会做的,只要学程序过程序就应该知道这个,但是我仍然看过不缩进的程序,或是乱缩进的程序,如果你的公司还有写程序不缩进的程序员,请毫不犹豫的开除他吧,并以破坏源码罪起诉他,还要他赔偿读过他程序的人的精神损失费。缩进,这是不成文规矩,我再重提一下吧,一个缩进一般是一个TAB键或是4个空格。(最好用TAB键) bIWcL$}4Q
7Dm^49H
ii) 空格。空格能给程序代来什么损失吗?没有,有效的利用空格可以让你的程序读进来更加赏心悦目。而不一堆表达式挤在一起。看看下面的代码: $8_*LR$
hc0VS3 k)
ha=(ha*128+*key++)%tabPtr->size; mYt(`S*q
Txoc
ha = ( ha * 128 + *key++ ) % tabPtr->size; r% mN]?u
.iew5.eB+
有空格和没有空格的感觉不一样吧。一般来说,语句中要在各个操作符间加空格,函数调用时,要以各个参数间加空格。如下面这种加空格的和不加的: zq1&MXR)l
HJg)c;u/2;
if ((hProc=OpenProcess(PROCESS_ALL_ACCESS,FALSE,pid))==NULL){ Z$WT ~V
} k"Sw,"e>+
#"7:NR^H^
if ( ( hProc = OpenProcess(PROCESS_ALL_ACCESS, FALSE, pid) ) == NULL ){ Y71b
Lg
} JanLJe)
\N"K^kR4
iii) 换行。不要把语句都写在一行上,这样很不好。如: rt~X(S
YrZAy5\
for(i=0;i'9')&&(a<'a'||a>'z')) break; cMK6
?cg+RNI
我拷,这种即无空格,又无换行的程序在写什么啊?加上空格和换行吧。 If4YqBG
!4oYQB
for ( i=0; i if ( ( a < '0' || a > '9' ) && #axRg=d?K
( a < 'a' || a > 'z' ) ) { {bc<0
break; |'KNR]:
N
} ?pQ, 5+8
} p}(w"?2
vBM\W%T|d
好多了吧?有时候,函数参数多的时候,最好也换行,如: MgtyO3GUAD
&V$'{
CreateProcess( v8pUt\m"
NULL, jl:O~UL6i
cmdbuf, aty
K^*aX
NULL, 'u696ED4
NULL, 1/1P;8F@G
bInhH, -,4_ &V
dwCrtFlags, VQo7se1P
envbuf, 7c;59$2(
NULL, @d4zSG/s5w
&siStartInfo, a o7|8[
&prInfo \=5CNe
); F7"Ihb^l
:;??!V
条件语句也应该在必要时换行: >Zmpsa+
1 !\pwd@{
if ( ch >= '0' || ch <= '9' || W%1fm/G0
ch >= 'a' || ch <= 'z' || AKAAb~{
ch >= 'A' || ch <= 'Z' ) jq =-Y
AHZ6
pl"|NZz
7;
iv) 空行。不要不加空行,空行可以区分不同的程序块,程序块间,最好加上空行。如: -,5g cD
x$s #';*
HANDLE hProcess; 03rZz1
PROCESS_T procInfo; _0vXujz
Hs-NP#I
/* open the process handle */ ]L_HnmD6
if((hProcess = OpenProcess(PROCESS_ALL_ACCESS, FALSE, pid)) == NULL) =20Q!wcu
{ +9h6{&yr1
return LSE_MISC_SYS; A#jiCIc
} j|? bva\
SULWPH5Pr
memset(&procInfo, 0, sizeof(procInfo)); ]pB~&0jg
procInfo.idProc = pid; C($`'~b
procInfo.hdProc = hProcess; ~:+g+Mf~[
procInfo.misc |= MSCAVA_PROC; +Z{4OJK
3q1O:b^eo
return(0); H_*]Vg
f-{[ushj
v) 对齐。用TAB键对齐你的一些变量的声明或注释,一样会让你的程序好看一些。如: IndNR:"g
Rj E,Wn
typedef struct _pt_man_t_ { >StvP=our
int numProc; /* Number of processes */ wkd591d*
int maxProc; /* Max Number of processes */ ,:L}S03k
int numEvnt; /* Number of events */ JBWiTUk
int maxEvnt; /* Max Number of events */ |f zo$Bq
HANDLE* pHndEvnt; /* Array of events */ w=^*)jZ8
DWORD timeout; /* Time out interval */ |]m&LC
HANDLE hPipe; /* Namedpipe */ 5T8!5EcS*
TCHAR usr[MAXUSR];/* User name of the process */ DF&C7+hO
int numMsg; /* Number of Message */ *~:@xMa
int Msg[MAXMSG];/* Space for intro process communicate */ wT.V3G
} PT_MAN_T; Tzk8y7$[
X2Lhb{ZHE
怎么样?感觉不错吧。 M#|TQa N
p>!r[v'
这里主要讲述了如果写出让人赏心悦目的代码,好看的代码会让人的心情愉快,读起代码也就不累,工整、整洁的程序代码,通常更让人欢迎,也更让人称道。现在的硬盘空间这么大,不要让你的代码挤在一起,这样它们会抱怨你虐待它们的。好了,用“缩进、空格、换行、空行、对齐”装饰你的代码吧,让他们从没有秩序的土匪中变成一排排整齐有秩序的正规部队吧。 a.]
!
aa".d[*1
mIr{Wocx
3、程序注释 XhIgzaGVu
—————— ^ePSI|EW
养成写程序注释的习惯,这是每个程序员所必须要做的工作。我看过那种几千行,却居然没有一行注释的程序。这就如同在公路上驾车却没有路标一样。用不了多久,连自己都不知道自己的意图了,还要花上几倍的时间才看明白,这种浪费别人和自己的时间的人,是最为可耻的人。 0kiW629o
|Ec $%
是的,你也许会说,你会写注释,真的吗?注释的书写也能看出一个程序员的功底。一般来说你需要至少写这些地方的注释:文件的注释、函数的注释、变量的注释、算法的注释、功能块的程序注释。主要就是记录你这段程序是干什么的?你的意图是什么?你这个变量是用来做什么的?等等。 !HB,{+25
D#k>.)g
不要以为注释好写,有一些算法是很难说或写出来的,只能意会,我承认有这种情况的时候,但你也要写出来,正好可以训练一下自己的表达能力。而表达能力正是那种闷头搞技术的技术人员最缺的,你有再高的技术,如果你表达能力不行,你的技术将不能得到充分的发挥。因为,这是一个团队的时代。 b1 KiO2
E
A: @=?(lI3
好了,说几个注释的技术细节: W)9KYI9u
OI`Lb\8pP
i) 对于行注释(“//”)比块注释(“/* */”)要好的说法,我并不是很同意。因为一些老版本的C编译器并不支持行注释,所以为了你的程序的移植性,请你还是尽量使用块注释。 K=B[MT#V{2
?Rl*5GRW
ii) 你也许会为块注释的不能嵌套而不爽,那么你可以用预编译来完成这个功能。使用“#if 0”和“#endif”括起来的代码,将不被编译,而且还可以嵌套。 M_XZOlW5
' bT9AV%
8KAyif@1::
4、函数的[in][out]参数 gK%&VzG4
——————————— >w*"LZjTTK
@D60
我经常看到这样的程序: 'wQ=b
FuncName(char* str) sJ0y3)PQ
{ _5X}&>>lhF
int len = strlen(str); ^qk$W?pX
..... WrD20Q$9Q
} VKs$J)6
UW>~C
char* >?tcL *
GetUserName(struct user* pUser) +"p",Z
{ bMv9f
J
return pUser->name; L4[bm[x
} 4wBCs0NIm
0`S!+d
不!请不要这样做。 5w1=j\oq
5jsnE )
你应该先判断一下传进来的那个指针是不是为空。如果传进来的指针为空的话,那么,你的一个大的系统就会因为这一个小的函数而崩溃。一种更好的技术是使用断言(assert),这里我就不多说这些技术细节了。当然,如果是在C++中,引用要比指针好得多,但你也需要对各个参数进行检查。 Gu%`__
Z]Qm64^I
写有参数的函数时,首要工作,就是要对传进来的所有参数进行合法性检查。而对于传出的参数也应该进行检查,这个动作当然应该在函数的外部,也就是说,调用完一个函数后,应该对其传出的值进行检查。 \?C(fpR
?]7ITF
当然,检查会浪费一点时间,但为了整个系统不至于出现“非法操作”或是“Core Dump”的系统级的错误,多花这点时间还是很值得的。 6f{ c
l"cO@.T3
i"-#1vy=
5、对系统调用的返回进行判断 +ATN2
o
—————————————— RCmPZ
继续上一条,对于一些系统调用,比如打开文件,我经常看到,许多程序员对fopen返回的指针不做任何判断,就直接使用了。然后发现文件的内容怎么也读出不,或是怎么也写不进去。还是判断一下吧: wZOO#&X#r
^iI^)
fp = fopen("log.txt", "a"); Aa1 |{^$:L
if ( fp == NULL ){ RL&*.r&
printf("Error: open file error\n"); KlrKGmy,)
return FALSE; Ne#nSx5,
} #~#_)\l'F
Cw+ (,1
其它还有许多啦,比如:socket返回的socket号,malloc返回的内存。请对这些系统调用返回的东西进行判断。 4bJ3uIP#
6、if 语句对出错的处理 $h$+EE!
——————————— Z4(2&t^
我看见你说了,这有什么好说的。还是先看一段程序代码吧。 P, Vq/Tt
if ( ch >= '0' && ch <= '9' ){ j$L<9(DoR
/* 正常处理代码 */ e~-Dk .i
}else{ /`'50Cj
/* 输出错误信息 */ f5yd2wKy6
printf("error ......\n"); FF/MTd}6qG
return ( FALSE ); |YlUt~H>
} w6E?TI
QOP*vH >J
这种结构很不好,特别是如果“正常处理代码”很长时,对于这种情况,最好不要用else。先判断错误,如: V)0bLR
HSUr
if ( ch < '0' || ch > '9' ){ 4$|G$h
/* 输出错误信息 */ #Y{"`5>
printf("error ......\n"); jf%Ydr}`
return ( FALSE ); k5ZwGJ#r
} l'o}4am
n;q7?KW8
/* 正常处理代码 */ lRO8}XSI
...... ^<E,aCy
"~+K`*0r8
dIf Jr}ih
这样的结构,不是很清楚吗?突出了错误的条件,让别人在使用你的函数的时候,第一眼就能看到不合法的条件,于是就会更下意识的避免。 =_wgKXBFa
ioviJ7N%
O
yV]-![`D
7、头文件中的#ifndef zcNV<tx
—————————— ):\pD]e
千万不要忽略了头件的中的#ifndef,这是一个很关键的东西。比如你有两个C文件,这两个C文件都include了同一个头文件。而编译时,这两个C文件要一同编译成一个可运行文件,于是问题来了,大量的声明冲突。 nY*ODL
|FcG$[
还是把头文件的内容都放在#ifndef和#endif中吧。不管你的头文件会不会被多个文件引用,你都要加上这个。一般格式是这样的: i/$lOde
A l` ;SWN
#ifndef <标识> G's/Q-'[\
#define <标识> N7M^
s/T5aJR
...... =-:o?&64
...... E@@quK
od|pI5St
#endif R]r~TJ o
c\x?k<=
<标识>在理论上来说可以是自由命名的,但每个头文件的这个“标识”都应该是唯一的。标识的命名规则一般是头文件名全大写,前后加下划线,并把文件名中的“.”也变成下划线,如:stdio.h YJ"gm]Pm
I @z{Gr
#ifndef _STDIO_H_ '<Vvv^Er
#define _STDIO_H_ ("TI~
|FNP~5v
...... kB8l`|
I
vx
,yz+yP
#endif |_ @iaLE
grS,PKH
(BTW:预编译有多很有用的功能。你会用预编译吗?) tl4;2m3w
UtWoSFZ'o!
6-JnT_
8、在堆上分配内存 \(z)]D
————————— O-G@To3\
可能许多人对内存分配上的“栈 stack”和“堆 heap”还不是很明白。包括一些科班出身的人也不明白这两个概念。我不想过多的说这两个东西。简单的来讲,stack上分配的内存系统自动释放,heap上分配的内存,系统不释放,哪怕程序退出,那一块内存还是在那里。stack一般是静态分配内存,heap上一般是动态分配内存。 iA < EJ
97BL%_^k
由malloc系统函数分配的内存就是从堆上分配内存。从堆上分配的内存一定要自己释放。用free释放,不然就是术语——“内存泄露”(或是“内存漏洞”)—— Memory Leak。于是,系统的可分配内存会随malloc越来越少,直到系统崩溃。还是来看看“栈内存”和“堆内存”的差别吧。 SEuj=Vie#
Ft|a/e
栈内存分配 eIEcj<f
————— Qv?jo(]
char* NT-du$!u
AllocStrFromStack() pG4Hy$e
{ u.arkp
char pstr[100]; OC[a?#R1
return pstr; W35nnBU
} gr7W&2x7\
@&~BGh
mDq01fU4
堆内存分配 bWyXDsr+
————— "Fke(?X'
char* {66vdAu&h<
AllocStrFromHeap(int len) 'shOSB
{ ?Cu$qE!h)[
char *pstr; D,)~j6OG8
BHU[Rz7x
if ( len <= 0 ) return NULL; p1&d@PF&&
return ( char* ) malloc( len ); "~Eo=R0O
} bcZHFX
<h;P<4JX
对于第一个函数,那块pstr的内存在函数返回时就被系统释放了。于是所返回的char*什么也没有。而对于第二个函数,是从堆上分配内存,所以哪怕是程序退出时,也不释放,所以第二个函数的返回的内存没有问题,可以被使用。但一定要调用free释放,不然就是Memory Leak! %"z W]
4dy)g)wM
在堆上分配内存很容易造成内存泄漏,这是C/C++的最大的“克星”,如果你的程序要稳定,那么就不要出现Memory Leak。所以,我还是要在这里千叮咛万嘱付,在使用malloc系统函数(包括calloc,realloc)时千万要小心。 :wF(([&4p!
Gm|QOuw
记得有一个UNIX上的服务应用程序,大约有几百的C文件编译而成,运行测试良好,等使用时,每隔三个月系统就是down一次,搞得许多人焦头烂额,查不出问题所在。只好,每隔两个月人工手动重启系统一次。出现这种问题就是Memery Leak在做怪了,在C/C++中这种问题总是会发生,所以你一定要小心。一个Rational的检测工作——Purify,可以帮你测试你的程序有没有内存泄漏。 }tJ:-!*2
bVVa5? HP
我保证,做过许多C/C++的工程的程序员,都会对malloc或是new有些感冒。当你什么时候在使用malloc和new时,有一种轻度的紧张和惶恐的感觉时,你就具备了这方面的修养了。 ZWr\v!4
@4Y>)wn&;
对于malloc和free的操作有以下规则: Zc"]Cv(
G%6wk=IH
1) 配对使用,有一个malloc,就应该有一个free。(C++中对应为new和delete)
+FJ
o!~1
2) 尽量在同一层上使用,不要像上面那种,malloc在函数中,而free在函数外。最好在同一调用层上使用这两个函数。 >!oN+8[~
3) malloc分配的内存一定要初始化。free后的指针一定要设置为NULL。 > W0hrt?b
2z-&Ya Qu
注:虽然现在的操作系统(如:UNIX和Win2k/NT)都有进程内存跟踪机制,也就是如果你有没有释放的内存,操作系统会帮你释放。但操作系统依然不会释放你程序中所有产生了Memory Leak的内存,所以,最好还是你自己来做这个工作。(有的时候不知不觉就出现Memory Leak了,而且在几百万行的代码中找无异于海底捞针,Rational有一个工具叫Purify,可能很好的帮你检查程序中的Memory Leak) Ii
K&v<(]
zxj!ihs<
&,#VhT![
9、变量的初始化 {6KU.'#iF
———————— ^@)+P/&
接上一条,变量一定要被初始化再使用。C/C++编译器在这个方面不会像JAVA一样帮你初始化,这一切都需要你自己来,如果你使用了没有初始化的变量,结果未知。好的程序员从来都会在使用变量前初始化变量的。如: k!%HcU%J
`S.;&%B\
1) 对malloc分配的内存进行memset清零操作。(可以使用calloc分配一块全零的内存) qS7*.E~j|]
2) 对一些栈上分配的struct或数组进行初始化。(最好也是清零) OrH&dY
<n#JOjHV
不过话又说回来了,初始化也会造成系统运行时间有一定的开销,所以,也不要对所有的变量做初始化,这个也没有意义。好的程序员知道哪些变量需要初始化,哪些则不需要。如:以下这种情况,则不需要。 kTnvD|3_!P
-&HN h\
char *pstr; /* 一个字符串 */ !.F\v.
pstr = ( char* ) malloc( 50 ); Pq`4Y
K
if ( pstr == NULL ) exit(0); 4o|~KX8Qz
strcpy( pstr, "Hello Wrold" ); $4L=Dg
^L[Z+7|
但如果是下面一种情况,最好进行内存初始化。(指针是一个危险的东西,一定要初始化) jQ[Z*^"}
fZGKVxo"
char **pstr; /* 一个字符串数组 */ )pzXC
pstr = ( char** ) malloc( 50 ); &556 ;l
if ( pstr == NULL ) exit(0); !"1bV
[^
rKjQEO$yi
/* 让数组中的指针都指向NULL */ HPgMVp'
memset( pstr, 0, 50*sizeof(char*) ); WUxr@0
Jv7M[SJ#x
而对于全局变量,和静态变量,一定要声明时就初始化。因为你不知道它第一次会在哪里被使用。所以使用前初始这些变量是比较不现实的,一定要在声明时就初始化它们。如: |Rl|Th
W]R5\G*
Links *plnk = NULL; /* 对于全局变量plnk初始化为NULL */ gG$o8c-
`&+L/
/wK7l-S
10、h和c文件的使用 U?}Ma f
————————— IMrB!bor
H文件和C文件怎么用呢?一般来说,H文件中是declare(声明),C文件中是define(定义)。因为C文件要编译成库文件(Windows下是.obj/.lib,UNIX下是.o/.a),如果别人要使用你的函数,那么就要引用你的H文件,所以,H文件中一般是变量、宏定义、枚举、结构和函数接口的声明,就像一个接口说明文件一样。而C文件则是实现细节。 'fgDe
0m@S+$v
H文件和C文件最大的用处就是声明和实现分开。这个特性应该是公认的了,但我仍然看到有些人喜欢把函数写在H文件中,这种习惯很不好。(如果是C++话,对于其模板函数,在VC中只有把实现和声明都写在一个文件中,因为VC不支持export关键字)。而且,如果在H文件中写上函数的实现,你还得在makefile中把头文件的依赖关系也加上去,这个就会让你的makefile很不规范。 !X,S2-}"
.a^/r'?
最后,有一个最需要注意的地方就是:带初始化的全局变量不要放在H文件中! -Pvt+I>
{=(4
例如有一个处理错误信息的结构: q6,xsO,+
qItI):9U
char* errmsg[] = { ,<[os
/* 0 */ "No error", #VrT)po+
/* 1 */ "Open file error", %ZxKN ;
/* 2 */ "Failed in sending/receiving a message", pjoI};
/* 3 */ "Bad arguments", 1k hwwoo
/* 4 */ "Memeroy is not enough", _\1(7 ?0D
/* 5 */ "Service is down; try later", +6>Pp[%
/* 6 */ "Unknow information", 1E-$f
/* 7 */ "A socket operation has failed", +\E\&^ZQ
/* 8 */ "Permission denied", Xau.4&\d
/* 9 */ "Bad configuration file format", ]>:>":<:
/* 10 */ "Communication time out", LZ@^ A]U
...... }^ iE|YKz
...... B
51LZP
}; tF;aB*
4$;fj1!Z:
请不要把这个东西放在头文件中,因为如果你的这个头文件被5个函数库(.lib或是.a)所用到,于是他就被链接在这5个.lib或.a中,而如果你的一个程序用到了这5个函数库中的函数,并且这些函数都用到了这个出错信息数组。那么这份信息将有5个副本存在于你的执行文件中。如果你的这个errmsg很大的话,而且你用到的函数库更多的话,你的执行文件也会变得很大。 F )tNA?p)
^@ux
正确的写法应该把它写到C文件中,然后在各个需要用到errmsg的C文件头上加上 extern char* errmsg[]; 的外部声明,让编译器在链接时才去管他,这样一来,就只会有一个errmsg存在于执行文件中,而且,这样做很利于封装。 n^A=ar.
AfY(+w6!K
我曾遇到过的最疯狂的事,就是在我的目标文件中,这个errmsg一共有112个副本,执行文件有8M左右。当我把errmsg放到C文件中,并为一千多个C文件加上了extern的声明后,所有的函数库文件尺寸都下降了20%左右,而我的执行文件只有5M了。一下子少了3M啊。 :@p`E}1r{
nd?m+C&W
[ 备注 ] Sj*H4ZHD<&
————— < ^&'r5H
有朋友对我说,这个只是一个特例,因为,如果errmsg在执行文件中存在多个副本时,可以加快程序运行速度,理由是errmsg的多个复本会让系统的内存换页降低,达到效率提升。像我们这里所说的errmsg只有一份,当某函数要用errmsg时,如果内存隔得比较远,会产生换页,反而效率不高。 sO*6F`eiZ
HY42G#^
这个说法不无道理,但是一般而言,对于一个比较大的系统,errmsg是比较大的,所以产生副本导致执行文件尺寸变大,不仅增加了系统装载时间,也会让一个程序在内存中占更多的页面。而对于errmsg这样数据,一般来说,在系统运行时不会经常用到,所以还是产生的内存换页也就不算频繁。权衡之下,还是只有一份errmsg的效率高。即便是像logmsg这样频繁使用的的数据,操作系统的内存调度算法会让这样的频繁使用的页面常驻于内存,所以也就不会出现内存换页问题了。 @<AIPla
'|+_~ZO*d
SY{J
11、出错信息的处理 mHhm~u
————————— ]A\n>Z!;
你会处理出错信息吗?哦,它并不是简单的输出。看下面的示例: K;Xn!:) V:
%? g]{
if ( p == NULL ){ {7;TQ?/
printf ( "ERR: The pointer is NULL\n" ); :DZiDJ@
} Lf,gS*Tg?
zZy>XHR
H
告别学生时代的编程吧。这种编程很不利于维护和管理,出错信息或是提示信息,应该统一处理,而不是像上面这样,写成一个“硬编码”。第10条对这方面的处理做了一部分说明。如果要管理错误信息,那就要有以下的处理: M\]E;C'"U
Fb*;5VNU.
/* 声明出错代码 */ ~C[,P\,
#define ERR_NO_ERROR 0 /* No error */ _,'UP>Si
#define ERR_OPEN_FILE 1 /* Open file error */ =];FojC6I
#define ERR_SEND_MESG 2 /* sending a message error */ 1HZexV
#define ERR_BAD_ARGS 3 /* Bad arguments */ j@:LMR>
#define ERR_MEM_NONE 4 /* Memeroy is not enough */ 4SOj>(a#
#define ERR_SERV_DOWN 5 /* Service down try later */ NT nn!k
#define ERR_UNKNOW_INFO 6 /* Unknow information */ Wl,yznT
#define ERR_SOCKET_ERR 7 /* Socket operation failed */ S}|ea2
#define ERR_PERMISSION 8 /* Permission denied */ a(
qw
#define ERR_BAD_formAT 9 /* Bad configuration file */ 3) 7'dM
#define ERR_TIME_OUT 10 /* Communication time out */ 9 (&!>z
kfHLjr.
/* 声明出错信息 */ OO@$jXZB
char* errmsg[] = { _6|b0*jv'&
/* 0 */ "No error", 7j]@3D9[:p
/* 1 */ "Open file error", {k)MC)%
/* 2 */ "Failed in sending/receiving a message", U9If%0P
/* 3 */ "Bad arguments", @GEvI2Vf.0
/* 4 */ "Memeroy is not enough", N0XGW_f
/* 5 */ "Service is down; try later", XR+2|o
/* 6 */ "Unknow information", 9*x9sfCv9
/* 7 */ "A socket operation has failed", $L&*0$[]Q
/* 8 */ "Permission denied", +yTL
/* 9 */ "Bad configuration file format", .c',?[S/vH
/* 10 */ "Communication time out", ePF9Vzq
}; leiza?[
{4I sz-P
/* 声明错误代码全局变量 */ B>'\g
O\2
long errno = 0; `aUA_"f
i^W\YLE
/* 打印出错信息函数 */ 59)PJ0E
void perror( char* info) uo%zfi?
{ 2vur_`cV
if ( info ){ )PwDP
printf("%s: %s\n", info, errmsg[errno] ); BvYJ!Vj
return; 3Y8%5/D5
} UR\*KR;yM
DS^Q0 f
printf("Error: %s\n", errmsg[errno] ); `,|7X]%b
} 5H5<ft,
dW=]|t&
这个基本上是ANSI的错误处理实现细节了,于是当你程序中有错误时你就可以这样处理: %>s y`c
aR3W9
bool CheckPermission( char* userName ) ._nhW*
{ }X`K3sk2/z
if ( strcpy(userName, "root") != 0 ){ R"tLu/S n
errno = ERR_PERMISSION_DENIED; F!Uk `[L
return (FALSE); *
5j iC
} [[)HPHSQ
2qEy"DKu
... mbd@4u
} 4u;W1=+Vn
w ggl,+7
main() `yf#(YP
{ _LS=O@s^
... 4}0s^>R
if (! CheckPermission( username ) ){ _ '}UNIL
perror("main()"); Nc7YMxk'H
} Y`_6Ny="
... p3-sEIw}Ru
} :JOF!Q
wvgX5P>
一个即有共性,也有个性的错误信息处理,这样做有利同种错误出一样的信息,统一用户界面,而不会因为文件打开失败,A程序员出一个信息,B程序员又出一个信息。而且这样做,非常容易维护。代码也易读。 $}jSIn=~|t
6 g!t1%Kb
当然,物极必反,也没有必要把所有的输出都放到errmsg中,抽取比较重要的出错信息或是提示信息是其关键,但即使这样,这也包括了大多数的信息。 #]C r
zLe
^v`|0z\
+`9T?:fu
12、常用函数和循环语句中的被计算量 Bkcs4 x
————————————————— 8
/\rmf\
看一下下面这个例子: 3cs'Oz<w
*l5/q\D
for( i=0; i<1000; i++ ){ * %MY. #
GetLocalHostName( hostname ); zIlQqyOQ8
... 5` Q#2
} }96^OQPE
Q2+e`
GetLocalHostName的意思是取得当前计算机名,在循环体中,它会被调用1000次啊。这是多么的没有效率的事啊。应该把这个函数拿到循环体外,这样只调用一次,效率得到了很大的提高。虽然,我们的编译器会进行优化,会把循环体内的不变的东西拿到循环外面,但是,你相信所有编译器会知道哪些是不变的吗?我觉得编译器不可靠。最好还是自己动手吧。 ,H|V\\
1|Fukx<@J<
同样,对于常用函数中的不变量,如: (llg!1
H*!E*_
GetLocalHostName(char* name) 3vMfms
{ -ERDW Y
char funcName[] = "GetLocalHostName"; JWEqy+,Fjw
9_&.G4%V
sys_log( "%s begin......", funcName ); $cYh X^YG.
... :V >Z|?[*H
sys_log( "%s end......", funcName ); Q.!D2RZc
} f>Ij:b`Z2
=i `o+H
如果这是一个经常调用的函数,每次调用时都要对funcName进行分配内存,这个开销很大啊。把这个变量声明成static吧,当函数再次被调用时,就会省去了分配内存的开销,执行效率也很好。 oo/#]a
aiz_6@Qfz*
;]'mx
13、函数名和变量名的命名 }PoB`H'K5
———————————— Xo'_|-N+
我看到许多程序对变量名和函数名的取名很草率,特别是变量名,什么a,b,c,aa,bb,cc,还有什么flag1,flag2, cnt1, cnt2,这同样是一种没有“修养”的行为。即便加上好的注释。好的变量名或是函数名,我认为应该有以下的规则: 0(64}T)
QV" |
1) 直观并且可以拼读,可望文知意,不必“解码”。 p6sXftk
2) 名字的长度应该即要最短的长度,也要能最大限度的表达其含义。 k3u3X~u
3) 不要全部大写,也不要全部小写,应该大小写都有,如:GetLocalHostName 或是 UserAccount。 /9i2@#J}W1
4) 可以简写,但简写得要让人明白,如:ErrorCode -> ErrCode, ServerListener -> ServLisner,UserAccount -> UsrAcct 等。 Id9hC<8$dq
5) 为了避免全局函数和变量名字冲突,可以加上一些前缀,一般以模块简称做为前缀。 teET nz_L
6) 全局变量统一加一个前缀或是后缀,让人一看到这个变量就知道是全局的。 N 0`)WLW
7) 用匈牙利命名法命名函数参数,局部变量。但还是要坚持“望文生意”的原则。 2'N%KKmJL
8) 与标准库(如:STL)或开发库(如:MFC)的命名风格保持一致。