二級指導(dǎo):C語言的編程風(fēng)格

字號:

第一:縮進(jìn)格式
    tab是8個(gè)字符,于是縮進(jìn)也是8個(gè)字符.有很多怪異的風(fēng)格,他們將縮進(jìn)格式定義為4個(gè)字符(設(shè)置為2個(gè)字符!)的深度,這就象試圖將pi定義為3一樣讓人難以接受.
    理由是:縮進(jìn)的大小是為了清楚的定義一個(gè)塊的開始和結(jié)束.特別是當(dāng)你已經(jīng)在計(jì)算機(jī)前面呆了20多個(gè)小時(shí)了以后,你會發(fā)現(xiàn)一個(gè)大的縮進(jìn)格式使得你對程序的理解更容易.
    現(xiàn)在,有一些人說,使用8個(gè)字符的縮進(jìn)使得代碼離右邊很近,在80個(gè)字符寬度的終端屏幕上看程序很難受.回答是,但你的程序有3個(gè)以上的縮進(jìn)的時(shí)候,你就應(yīng)該修改你的程序.
    總之,8個(gè)字符的縮進(jìn)使得程序易讀,還有一個(gè)附加的好處,就是它能在你將程序變得嵌套層數(shù)太多的時(shí)候給你警告.這個(gè)時(shí)候,你應(yīng)該修改你的程序.
    第二:大符號的位置
    另外一個(gè)c程序編程風(fēng)格的問題是對大括號的處理.同縮進(jìn)大小不同,幾乎沒有什么理由去選擇一種而不選擇另外一種風(fēng)格,但有一種推薦的風(fēng)格,它是kernighan和ritchie的經(jīng)典的那本書帶來的,它將開始
    的大括號放在一行的最后,而將結(jié)束大括號放在一行的第一位,如下所示:
    if (x is true) { we do y }
    然而,還有一種特殊的情況:命名函數(shù):開始的括號是放在下一行的第一位,如下:
    int function(int x) { body of function }
    所有非正統(tǒng)的人會非難這種不一致性,但是,所有思維正常的人明白: (第一) k&r是___對___的,(第二)如果k&r不對,請參見第一條. (:-))......另外,函數(shù)也是特殊的,不一定非得一致.
    需要注意的是結(jié)束的括號在它所占的那一行是空的,__除了__它跟隨著同一條語句的繼續(xù)符號.如'while'在do-while循環(huán)中,或者'else'在if語句中.如下:
    do { body of do-loop } while (condition);
    以及
    if (x == y) { .. } else if (x > y) { ... } else { .... }
    理由: k&r.
    另外,注意到這種大括號的放置方法減小了空行的數(shù)量,但卻沒有減少可讀性.于是,在屏幕大小受到限制的時(shí)候,你就可以有更多的空行來寫些注釋了.
    第三:命名系統(tǒng)
    c是一種簡潔的語言,那么,命名也應(yīng)該是簡潔的.同module-2以及ascal語言不同的是,c程序員不使用諸如thisvariableisatemporarycounter之類的命名方式.一個(gè)c語言的程序員會將之命名為'tmp',這很容易書寫,且并不是那么難以去理解.
    然而,當(dāng)混合類型的名字不得不出現(xiàn)的時(shí)候,描述性名字對全局變量來說是必要的了.調(diào)用一個(gè)名為'foo'全局的函數(shù)是很讓人惱火的.全局變量(只有你必須使用的時(shí)候才使用它) ,就象全局函數(shù)一樣,需要描述性的命名方式.假如你有一個(gè)函數(shù)用來計(jì)算活動(dòng)用戶的數(shù)量,你應(yīng)該這樣命名--'count_active_users()'--或另外的相近的形式,你不應(yīng)命名為'cntusr()'.
    有一種稱為hungarian命名方式,它將函數(shù)的類型編碼寫入變量名中,這種方式是腦子有毛病的一種表現(xiàn)---編譯器知道這個(gè)類型而且會去檢查它,而這樣只會迷惑程序員. --知道為什么micro$oft為什么會生產(chǎn)這么多'臭蟲'程序了把!!.
    局部變量的命名應(yīng)該短小精悍.假如你有一個(gè)隨機(jī)的整數(shù)循環(huán)計(jì)數(shù)器,它有可能有'i',如果沒有任何可能使得它能被誤解的話,將其寫作'loop_counter'是效率低下的.同樣的,''tmp'可以是任何臨時(shí)數(shù)值的函數(shù)變量.
    如果你害怕混淆你的局部變量的名字,還有另外一個(gè)問題,就是稱
    function-growth-hormone-imbalancesyndrome.
    第四:函數(shù)
    函數(shù)應(yīng)該短小而迷人,而且它只作一件事情.它應(yīng)只覆蓋一到兩個(gè)屏幕(80*24一屏),并且只作一件事情,而且將它做好.(這不就是unix的風(fēng)格嗎,譯者注).
    一個(gè)函數(shù)的長度和函數(shù)的復(fù)雜程度以及縮進(jìn)大小成反比.于是,如果你已經(jīng)寫了簡單但長度較長的的函數(shù),而且你已經(jīng)對不同的情況做了很多很小的事情,寫一個(gè)更長一點(diǎn)的函數(shù)也是無所謂的.
    然而,假如你要寫一個(gè)很復(fù)雜的函數(shù),而且你已經(jīng)估計(jì)到假如一般人讀這個(gè)函數(shù),他可能都不知道這個(gè)函數(shù)在說些什么,這個(gè)時(shí)候,使用具有描述性名字的有幫助的函數(shù).
    另外一個(gè)需要考慮的是局部變量的數(shù)量.他們不應(yīng)該超過5-10個(gè),否則你有可能會出錯(cuò).重新考慮這個(gè)函數(shù),將他們分割成更小的函數(shù).人的大腦通??梢院苋菀椎挠涀?件不同的事情,超過這個(gè)數(shù)量會引起混亂.你知道你很聰明,但是你可能仍想去明白2周以前的做的事情.
    第5:注釋
    注釋是一件很好的事情,但是過多的注釋也是危險(xiǎn)的,不要試圖區(qū)解釋你的代碼是注釋如何如何的好:你應(yīng)該將代碼寫得更好,而不是花費(fèi)大量的時(shí)間去解釋那些糟糕的代碼.
    通常情況下,你的注釋是說明你的代碼做些什么,而不是怎么做的.而且,要試圖避免將注釋插在一個(gè)函數(shù)體里:假如這個(gè)函數(shù)確實(shí)很復(fù)雜,你需要在其中有部分的注釋,你應(yīng)該回到第四章看看.你可以寫些簡短的注釋來注明或警告那些你認(rèn)為特別聰明(或極其丑陋)的部分,但是你必須要避免過多.取而代之的是,將注釋寫在函數(shù)前,告訴別人它做些什么事情,和可能為什么要這樣做.
    第六:你已經(jīng)深陷其中了.
    不要著急.你有可能已經(jīng)被告之'gun emacs'會自動(dòng)的幫你處理c的源代碼格式,而且你已經(jīng)看到它確實(shí)如此,但是,缺省的情況下,它的作用還是不盡如人意(實(shí)際上,他們比隨便敲出來的東西還要難看- ainfinite number of monkeys typing into gnu emacs would never make a good program)
    于是,你可以要么不要使用gun emacs,要么讓它使用sanervalules.使用后者,你需要將如下的語句輸入到你的.emacs文件中.(defun linux-c-mode() 'c mode with adjusted defaults for use with the linux kernel.'(interactive) (c-mode) (c-set-style'k&r') (setq c-basic-offset8))
    這會定義一個(gè)m-x linux-c-mode的命令.當(dāng)你hacking一個(gè)模塊的時(shí)候,如何你將-*- linux-c -*-輸入在最開始的兩行,這個(gè)模式會自動(dòng)起作用.而且,你也許想加入如下
    (setq auto-mode-alist (cons '('/usr/src/linux.*/.*//.〖ch〗$' . linux-c-mode) auto-mode-alist))
    到你的.emacs文件中,這樣的話,當(dāng)你在/usr/src/linux下編輯文件的時(shí)候,它會自動(dòng)切換到linux-c-mode .
    但是,假如你還不能讓emaces去自動(dòng)處理文件的格式,不要緊張,你還有一樣?xùn)|西: '縮進(jìn)' .
    gnu的縮進(jìn)格式也很死板,這就是你為什么需要加上幾行命令選項(xiàng).然而,這還不算太壞,因?yàn)間nu縮進(jìn)格式的創(chuàng)造者也記得k&r的權(quán)威, (gnu沒有罪,他們僅僅是在這件事情上錯(cuò)誤的引導(dǎo)了人們) ,你要做的就只有輸入選項(xiàng)'-kr -i8'(表示'k&r,縮進(jìn)8個(gè)字符).
    '縮進(jìn)'有很多功能,特別是當(dāng)它建議你重新格式你的代碼的時(shí)候,你應(yīng)該看看幫助.但要記住: '縮進(jìn)'不是風(fēng)格很差的程序的萬靈丹.