- 相關(guān)推薦
四級(jí)上機(jī)編程修養(yǎng)
1、版權(quán)和版本
———————
好的程序員會(huì)給自己的每個(gè)函數(shù),每個(gè)文件,都注上版權(quán)和版本。
對(duì)于C/C 的文件,文件頭應(yīng)該有類似這樣的注釋:
/************************************************************************
*
* 文件名:network.c
*
* 文件描述:網(wǎng)絡(luò)通訊函數(shù)集
*
* 創(chuàng)建人: Hao Chen, 2003年2月3日
*
* 版本號(hào):1.0
*
* 修改記錄:
*
*
************************************************************************/
而對(duì)于函數(shù)來(lái)說(shuō),應(yīng)該也有類似于這樣的注釋:
/*================================================================
*
* 函 數(shù) 名:XXX
*
* 參 數(shù):
*
* type name [IN] : descripts
*
* 功能描述:
*
* ..............
*
* 返 回 值:成功TRUE,失敗FALSE
*
* 拋出異常:
*
* 作 者:ChenHao 2003/4/2
*
*
================================================================*/
這樣的描述可以讓人對(duì)一個(gè)函數(shù),一個(gè)文件有一個(gè)總體的認(rèn)識(shí),對(duì)代碼的易讀性和易維護(hù)
性有很大的好處。這是好的作品產(chǎn)生的開始。
2、縮進(jìn)、空格、換行、空行、對(duì)齊
————————————————
i) 縮進(jìn)應(yīng)該是每個(gè)程序都會(huì)做的,只要學(xué)程序過(guò)程序就應(yīng)該知道這個(gè),但是我仍然看過(guò)不
縮進(jìn)的程序,或是亂縮進(jìn)的程序,如果你的公司還有寫程序不縮進(jìn)的程序員,請(qǐng)毫不猶豫
的開除他吧,并以破壞源碼罪起訴他,還要他賠償讀過(guò)他程序的人的精神損失費(fèi)?s進(jìn),
這是不成文規(guī)矩,我再重提一下吧,一個(gè)縮進(jìn)一般是一個(gè)TAB鍵或是4個(gè)空格。(最好用TAB
鍵)
ii) 空格?崭衲芙o程序代來(lái)什么損失嗎?沒(méi)有,有效的利用空格可以讓你的程序讀進(jìn)來(lái)
更加賞心悅目。而不一堆表達(dá)式擠在一起。看看下面的代碼:
ha=(ha*128 *key )%tabPtr->size;
ha = ( ha * 128 *key ) % tabPtr->size;
有空格和沒(méi)有空格的感覺(jué)不一樣吧。一般來(lái)說(shuō),語(yǔ)句中要在各個(gè)操作符間加空格,函
數(shù)調(diào)用時(shí),要以各個(gè)參數(shù)間加空格。如下面這種加空格的和不加的:
if ((hProc=OpenProcess(PROCESS_ALL_ACCESS,FALSE,pid))==NULL){
}
if ( ( hProc = OpenProcess(PROCESS_ALL_ACCESS, FALSE, pid) ) == NULL ){
}
iii) 換行。不要把語(yǔ)句都寫在一行上,這樣很不好。如:
for(i=0;i
我拷,這種即無(wú)空格,又無(wú)換行的程序在寫什么啊?加上空格和換行吧。
for ( i=0; i
if ( ( a[i] < ’0’ || a[i] > ’9’ ) &&
( a[i] < ’a’ || a[i] > ’z’ ) ) {
break;
}
}
好多了吧?有時(shí)候,函數(shù)參數(shù)多的時(shí)候,最好也換行,如:
CreateProcess(
NULL,
cmdbuf,
NULL,
NULL,
bInhH,
dwCrtFlags,
envbuf,
NULL,
&siStartInfo,
&prInfo
);
條件語(yǔ)句也應(yīng)該在必要時(shí)換行:
if ( ch >= ’0’ || ch <= ’9’ ||
ch >= ’a’ || ch <= ’z’ ||
ch >= ’A’ || ch <= ’Z’ )
iv) 空行。不要不加空行,空行可以區(qū)分不同的程序塊,程序塊間,最好加上空行。如:
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 |= MSC***A_PROC;
return(0);
v) 對(duì)齊。用TAB鍵對(duì)齊你的一些變量的聲明或注釋,一樣會(huì)讓你的程序好看一些。如:
typedef struct _pt_man_t_ {
int numProc; /* Number of processes */
int maxProc; /* Max 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;
怎么樣?感覺(jué)不錯(cuò)吧。
這里主要講述了如果寫出讓人賞心悅目的代碼,好看的代碼會(huì)讓人的心情愉快,讀起代碼
也就不累,工整、整潔的程序代碼,通常更讓人歡迎,也更讓人稱道,F(xiàn)在的硬盤空間這
么大,不要讓你的代碼擠在一起,這樣它們會(huì)抱怨你虐待它們的。好了,用“縮進(jìn)、空格
、換行、空行、對(duì)齊”裝飾你的代碼吧,讓他們從沒(méi)有秩序的土匪中變成一排排整齊有秩
序的正規(guī)部隊(duì)吧。
3、程序注釋
——————
養(yǎng)成寫程序注釋的習(xí)慣,這是每個(gè)程序員所必須要做的工作。我看過(guò)那種幾千行,卻居然
沒(méi)有一行注釋的程序。這就如同在公路上駕車卻沒(méi)有路標(biāo)一樣。用不了多久,連自己都不
知道自己的意圖了,還要花上幾倍的時(shí) 間才看明白,這種浪費(fèi)別人和自己的時(shí) 間的人,是
最為可恥的人。
是的,你也許會(huì)說(shuō),你會(huì)寫注釋,真的嗎?注釋的書寫也能看出一個(gè)程序員的功底。一般
來(lái)說(shuō)你需要至少寫這些地方的注釋:文件的注釋、函數(shù)的注釋、變量的注釋、算法的注釋
、功能塊的程序注釋。主要就是記錄你這段程序是干什么的?你的意圖是什么?你這個(gè)變
量是用來(lái)做什么的?等等。
不要以為注釋好寫,有一些算法是很難說(shuō)或?qū)懗鰜?lái)的,只能意會(huì),我承認(rèn)有這種情況的時(shí)
候,但你也要寫出來(lái),正好可以訓(xùn)練一下自己的表達(dá)能力。而表達(dá)能力正是那種悶頭搞技
術(shù)的技術(shù)人員最缺的,你有再高的技術(shù),如果你表達(dá)能力不行,你的技術(shù)將不能得到充分
的發(fā)揮。因?yàn),這是一個(gè)團(tuán)隊(duì)的時(shí)代。
好了,說(shuō)幾個(gè)注釋的技術(shù)細(xì)節(jié):
i) 對(duì)于行注釋(“//”)比塊注釋(“/* */”)要好的說(shuō)法,我并不是很同意。因?yàn)橐?/p>
些老版本的C編譯器并不支持行注釋,所以為了你的程序的移植性,請(qǐng)你還是盡量使用塊注
釋。
ii) 你也許會(huì)為塊注釋的不能嵌套而不爽,那么你可以用預(yù)編譯來(lái)完成這個(gè)功能。使用“#
if 0”和“#endif”括起來(lái)的代碼,將不被編譯,而且還可以嵌套。
4、函數(shù)的[in][out]參數(shù)
———————————
我經(jīng)?吹竭@樣的程序:
FuncName(char* str)
{
int len = strlen(str);
.....
}
char*
GetUserName(struct user* pUser)
{
return pUser->name;
}
不!請(qǐng)不要這樣做。
你應(yīng)該先判斷一下傳進(jìn)來(lái)的那個(gè)指針是不是為空。如果傳進(jìn)來(lái)的指針為空的話,那么,你
的一個(gè)大的系統(tǒng)就會(huì)因?yàn)檫@一個(gè)小的函數(shù)而崩潰。一種更好的技術(shù)是使用斷言(assert)
,這里我就不多說(shuō)這些技術(shù)細(xì)節(jié)了。當(dāng)然,如果是在C 中,引用要比指針好得多,但你也
需要對(duì)各個(gè)參數(shù)進(jìn)行檢查。
寫有參數(shù)的函數(shù)時(shí),首要工作,就是要對(duì)傳進(jìn)來(lái)的所有參數(shù)進(jìn)行合法性檢查。而對(duì)于傳出
的參數(shù)也應(yīng)該進(jìn)行檢查,這個(gè)動(dòng)作當(dāng)然應(yīng)該在函數(shù)的外部,也就是說(shuō),調(diào)用完一個(gè)函數(shù)后
,應(yīng)該對(duì)其傳出的值進(jìn)行檢查。
當(dāng)然,檢查會(huì)浪費(fèi)一點(diǎn)時(shí) 間,但為了整個(gè)系統(tǒng)不至于出現(xiàn)“非法操作”或是“Core Dump”
的系統(tǒng)級(jí)的錯(cuò)誤,多花這點(diǎn)時(shí) 間還是很值得的。
5、對(duì)系統(tǒng)調(diào)用的返回進(jìn)行判斷
——————————————
繼續(xù)上一條,對(duì)于一些系統(tǒng)調(diào)用,比如打開文件,我經(jīng)常看到,許多程序員對(duì)fopen返回的
指針不做任何判斷,就直接使用了。然后發(fā)現(xiàn)文件的內(nèi)容怎么也讀出不,或是怎么也寫不
進(jìn)去。還是判斷一下吧:
fp = fopen("log.txt", "a");
if ( fp == NULL ){
printf("Error: open file error\n");
return FALSE;
}
其它還有許多啦,比如:socket返回的socket號(hào),malloc返回的內(nèi)存。請(qǐng)對(duì)這些系統(tǒng)調(diào)用
返回的東西進(jìn)行判斷。
1、版權(quán)和版本
———————
好的程序員會(huì)給自己的每個(gè)函數(shù),每個(gè)文件,都注上版權(quán)和版本。
對(duì)于C/C 的文件,文件頭應(yīng)該有類似這樣的注釋:
/************************************************************************
*
* 文件名:network.c
*
* 文件描述:網(wǎng)絡(luò)通訊函數(shù)集
*
* 創(chuàng)建人: Hao Chen, 2003年2月3日
*
* 版本號(hào):1.0
*
* 修改記錄:
*
*
************************************************************************/
而對(duì)于函數(shù)來(lái)說(shuō),應(yīng)該也有類似于這樣的注釋:
/*================================================================
*
* 函 數(shù) 名:XXX
*
* 參 數(shù):
*
* type name [IN] : descripts
*
* 功能描述:
*
* ..............
*
* 返 回 值:成功TRUE,失敗FALSE
*
* 拋出異常:
*
* 作 者:ChenHao 2003/4/2
*
*
相關(guān)推薦:
科目三路考起步須知
2013年駕照考試新規(guī)定
駕照考試題100道
機(jī)動(dòng)車駕駛員科目二倒樁技巧
科目二考試介紹
c1駕照考試科目二
【四級(jí)上機(jī)編程修養(yǎng)】相關(guān)文章:
2016年計(jì)算機(jī)四級(jí)上機(jī)編程題型10-01
2017計(jì)算機(jī)等級(jí)考試四級(jí)上機(jī)編程題練習(xí)10-13
全國(guó)計(jì)算機(jī)等級(jí)考試四級(jí)上機(jī)編程題07-11
全國(guó)計(jì)算機(jī)等級(jí)考試四級(jí)上機(jī)編程題型09-15
2016年計(jì)算機(jī)考試四級(jí)上機(jī)編程題型08-21
2016年計(jì)算機(jī)等級(jí)考試四級(jí)上機(jī)編程試題及答案08-30
2016年全國(guó)計(jì)算機(jī)等級(jí)考試四級(jí)上機(jī)編程題型07-08