? ???版式雖然不會影響程序的功能,但會影響可讀性。程序的版式追求清晰、美觀,是程序風格的重要構成因素。可以把程序的版式比喻為“書法”。好的“書法”可讓人對程序一目了然,看得興致勃勃。差的程序“書法”如螃蟹爬行,讓人看得索然無味,更令維護者煩惱有加。請程序員們學習程序的“書法”,彌補大學計算機教育的漏洞,實在很有必要。
?
空行
??????? 【規則2-1-1】在每個類聲明之后、每個函數定義結束之后都要加空行。
??????? 【規則2-1-2】在一個函數體內,邏揖上密切相關的語句之間不加空行,其它地方應加空行分隔。
?
代碼行
? ? ? ? 【規則2-2-1】一行代碼只做一件事情,如只定義一個變量,或只寫一條語句。
??????? 【規則2-2-2】if、for、while、do等語句自占一行,執行語句不得緊跟其后。不論執行語句有多少都要加{}。這樣可以防止書寫失誤。
??????? 【建議2-2-1】盡可能在定義變量的同時初始化該變量(就近原則)。
?
代碼行內的空格
???????【規則2-3-1】關鍵字之后要留空格。象const、virtual、inline、case?等關鍵字之后至少要留一個空格,否則無法辨析關鍵字。象if、for、while等關鍵字之后應留一個空格再跟左括號‘(’,以突出關鍵字。
???? 【規則2-3-2】函數名之后不要留空格,緊跟左括號‘(’,以與關鍵字區別。
? ? ? ?【規則2-3-3】‘(’向后緊跟,‘)’、‘,’、‘;’向前緊跟,緊跟處不留空格。
? ? ? ?【規則2-3-4】‘,’之后要留空格,如Function(x,y, z)。如果‘;’不是一行的結束符號,其后要留空格,如for (initialization;condition; update)。
? ? ? ?【規則2-3-5】賦值操作符、比較操作符、算術操作符、邏輯操作符、位域操作符,如“=”、“+=”?“>=”、“<=”、“+”、“*”、“%”、“&&”、“||”、“<<”,“^”等二元操作符的前后應當加空格。
? ? ? ?【規則2-3-6】一元操作符如“!”、“~”、“++”、“--”、“&”(地址運算符)等前后不加空格。
? ? ? ?【規則2-3-7】象“[]”、“.”、“->”這類操作符前后不加空格。
? ? ? ?【建議2-3-1】對于表達式比較長的for語句和if語句,為了緊湊起見可以適當地去掉一些空格,如for (i=0; i<10; i++)和if((a<=b) && (c<=d))。
?
對齊
?? ?【規則2-4-1】程序的分界符‘{’和‘}’應獨占一行并且位于同一列,同時與引用它們的語句左對齊。
? ? 【規則2-4-2】{ }之內的代碼塊在‘{’右邊數格處左對齊。
?
長行拆分
????【規則2-5-1】代碼行最大長度宜控制在70至80個字符以內。代碼行不要過長,否則眼睛看不過來,也不便于打印。
????【規則2-5-2】長表達式要在低優先級操作符處拆分成新行,操作符放在新行之首(以便突出操作符)。拆分出的新行要進行適當的縮進,使排版整齊,語句可讀。
?
修飾符的位置
??? 【規則2-6-1】應當將修飾符?*?和?&?緊靠變量名。
?
注釋
C語言的注釋符為“/*…*/”。C++語言中,程序塊的注釋常采用“/*…*/”,行注釋一般采用“//…”。注釋通常用于:
(1)版本、版權聲明;
(2)函數接口說明;
(3)重要的代碼行或段落提示。
雖然注釋有助于理解代碼,但注意不可過多地使用注釋。
??????【規則2-7-1】注釋是對代碼的“提示”,而不是文檔。程序中的注釋不可喧賓奪主,注釋太多了會讓人眼花繚亂。注釋的花樣要少。
??????【規則2-7-2】如果代碼本來就是清楚的,則不必加注釋。否則多此一舉,令人厭煩。例如i++;????// i 加1,多余的注釋。
??????【規則2-7-3】邊寫代碼邊注釋,修改代碼同時修改相應的注釋,以保證注釋與代碼的一致性。不再有用的注釋要刪除。
??????【規則2-7-4】注釋應當準確、易懂,防止注釋有二義性。錯誤的注釋不但無益反而有害。
??????【規則2-7-5】盡量避免在注釋中使用縮寫,特別是不常用縮寫。
??????【規則2-7-6】注釋的位置應與被描述的代碼相鄰,可以放在代碼的上方或右方,不可放在下方。
??????【規則2-7-8】當代碼比較長,特別是有多重嵌套時,應當在一些段落的結束處加注釋,便于閱讀。
?
類的版式
類可以將數據和函數封裝在一起,其中函數表示了類的行為(或稱服務)。類提供關鍵字public、protected和private,分別用于聲明哪些數據和函數是公有的、受保護的或者是私有的。這樣可以達到信息隱藏的目的,即讓類僅僅公開必須要讓外界知道的內容,而隱藏其它一切內容。我們不可以濫用類的封裝功能,不要把它當成火鍋,什么東西都往里扔。
?
類的版式主要有兩種方式:
(1)將private類型的數據寫在前面,而將public類型的函數寫在后面。采用這種版式的程序員主張類的設計“以數據為中心”,重點關注類的內部結構。
(2)將public類型的函數寫在前面,而將private類型的數據寫在后面。采用這種版式的程序員主張類的設計“以行為為中心”,重點關注的是類應該提供什么樣的接口(或服務)。
?
很多C++教課書受到BiarneStroustrup第一本著作的影響,不知不覺地采用了“以數據為中心”的書寫方式,并不見得有多少道理。
建議采用“以行為為中心”的書寫方式,即首先考慮類應該提供什么樣的函數。這是很多人的經驗——“這樣做不僅讓自己在設計類時思路清晰,而且方便別人閱讀。因為用戶最關心的是接口,誰愿意先看到一堆私有數據成員!”