第二章 程序的板式

2.1 空行
規(guī)則 2-1-1 在每個(gè)類聲明之后、每個(gè)函數(shù)定義結(jié)束之后都要加空行。
規(guī)則 2-1-2 在一個(gè)函數(shù)體內(nèi),邏輯上密切相關(guān)的語(yǔ)句之間不加空行,其他地方應(yīng)加空行分隔。

2.2 代碼行
規(guī)則 2-2-1 一行代碼只做一件事情,如只定義一個(gè)變量,或只寫一條語(yǔ)句。
規(guī)則 2-2-2 if、for、while、do等語(yǔ)句自占一行,執(zhí)行語(yǔ)句不得緊跟其后。無論執(zhí)行語(yǔ)句有多少都要加{}。
建議 2-2-1 盡可能在定義變量的同時(shí)初始化該變量。

2.3 代碼行內(nèi)的空格
規(guī)則 2-3-1 關(guān)鍵字之后要留空格。
規(guī)則 2-3-2 函數(shù)名之后不要留空格,緊跟左括號(hào)。
規(guī)則 2-3-3 '(' 向后緊跟, ')'、','、';'向前緊跟,緊跟處不留空格。
規(guī)則 2-3-4 ','之后要留空格,如果';'不是一行的結(jié)束符合,其后留空格。
規(guī)則 2-3-5 賦值操作符、比較操作符、算數(shù)操作符、邏輯操作符、位域操作符等二元操作符的前后應(yīng)當(dāng)加空格。
規(guī)則 2-3-6 一元操作符如"++"、"!"等前后不加空格。
規(guī)則 2-3-7 像"[]"、"."、"->"這類操作符前后不加空格。
建議 2-3-1 對(duì)于表達(dá)式比較長(zhǎng)的for語(yǔ)句和if語(yǔ)句,為了緊湊起見可以適當(dāng)?shù)厝サ粢恍┛崭瘛?/p>

2.4 對(duì)齊
規(guī)則 2-4-1 程序的分界符'{'和'}'應(yīng)獨(dú)占一行并且位于同一列,同時(shí)引用它們的語(yǔ)句左對(duì)齊。
規(guī)則 2-4-2 {}之內(nèi)的代碼塊在'{'右邊數(shù)格處對(duì)齊。

2.5 長(zhǎng)行拆分
規(guī)則 2-5-1 代碼行最大長(zhǎng)度宜控制在70到80個(gè)字符以內(nèi)。
規(guī)則 2-5-2 長(zhǎng)表達(dá)式要在低優(yōu)先級(jí)操作符處拆分成新行,操作符放在新行之首(以
便突出操作符)。拆分出的新行要進(jìn)行適當(dāng)?shù)目s進(jìn),使排版整齊,語(yǔ)句可讀。

2.6 修飾符的位置
規(guī)則 2-6-1 應(yīng)當(dāng)將修飾符 * 和&緊靠變量名

2.7 注釋
規(guī)則2-7-1 注釋是對(duì)代碼的“提示”,而不是文檔。程序中的注釋不可喧賓奪主,
注釋太多了會(huì)讓人眼花繚亂。注釋的花樣要少。
規(guī)則2-7-2 如果代碼本來就是清楚的,則不必加注釋。否則多此一舉,令人厭煩。
規(guī)則2-7-3 邊寫代碼邊注釋,修改代碼同時(shí)修改相應(yīng)的注釋,以保證注釋與代碼
的一致性。
規(guī)則2-7-4 注釋應(yīng)當(dāng)準(zhǔn)確、易懂,防止注釋有二義性。錯(cuò)誤的注釋不但無益反而
有害。
規(guī)則2-7-5 盡量避免在注釋中使用縮寫,特別是不常用縮寫。
規(guī)則2-7-6 注釋的位置應(yīng)與被描述的代碼相鄰,可以放在代碼的上方或右方,不
可放在下方。
規(guī)則2-7-8 當(dāng)代碼比較長(zhǎng),特別是有多重嵌套時(shí),應(yīng)當(dāng)在一些段落的結(jié)束處加注
釋,便于閱讀。

2.8 類的版式
推薦將public類型的函數(shù)寫在前面,而將private類型的數(shù)據(jù)寫在后面。重點(diǎn)關(guān)注的是類應(yīng)該提供什么樣的接口(或服務(wù))。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡(jiǎn)書系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

推薦閱讀更多精彩內(nèi)容