《C++/C高品質編程指南》筆記

標籤：opengl   float   form   別人   span   代碼塊   post   品質   導致   

　　

複習：

C/C++高品質編程指南；

【規則1-2-1】為了防止標頭檔被重複引用，應當用ifndef/define/endif結構產生預先處理塊。

【規則1-2-2】用 #include <filename.h> 格式來引用標準庫的標頭檔（編譯器將從標準庫目錄開始搜尋）。

【規則1-2-3】用 #include “filename.h” 格式來引用非標準庫的標頭檔（編譯器將從使用者的工作目錄開始搜尋）。

【建議1-2-1】標頭檔中只存放“聲明”而不存放“定義”

【規則2-2-1】一行代碼只做一件事情，如只定義一個變數，或唯寫一條語句。這樣的代碼容易閱讀，並且方便於寫注釋。（不贊同附錄考題while((*strDest++ = * strSrc++) != ‘\0’)）的寫法還是分開寫可讀性會比較好，我認為分開寫應該可讀性會比較好）。

【規則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】應當將修飾符 * 和 ＆ 緊靠變數名

【規則2-7-1】注釋是對代碼的“提示”，而不是文檔。程式中的注釋不可喧賓奪主，注釋太多了會讓人眼花繚亂。注釋的花樣要少。

【規則2-7-2】如果代碼本來就是清楚的，則不必加註釋。否則多此一舉，令人厭煩。例如

i++;     // i 加 1，多餘的注釋

【規則2-7-3】邊寫代碼邊注釋，修改代碼同時修改相應的注釋，以保證注釋與代碼的一致性。不再有用的注釋要刪除。

【規則2-7-4】注釋應當準確、易懂，防止注釋有二義性。錯誤的注釋不但無益反而有害。

【規則2-7-5】盡量避免在注釋中使用縮寫，特別是不常用縮寫。

【規則2-7-6】注釋的位置應與被描述的代碼相鄰，可以放在代碼的上方或右方，不可放在下方。

【規則2-7-8】當代碼比較長，特別是有多重嵌套時，應當在一些段落的結束處加註釋，便於閱讀。(這個很多編輯器像source insight這種的會顯示段落的結束位置)

【規則3-1-1】標識符應當直觀且可以拼讀，可望文知意，不必進行“解碼”。

【規則3-1-2】標識符的長度應當符合“min-length && max-information”原則。

【規則3-1-3】命名規則盡量與所採用的作業系統或開發工具的風格保持一致。(如模仿linux調用的Glib庫中API的命名，當模仿實現自己的作業系統的介面應該要與原型一致，這樣在開發調用API時不用再重新看API的說明)

【規則3-1-4】程式中不要出現僅靠大小寫區分的相似的標識符。

【規則3-1-5】程式中不要出現標識符完全相同的局部變數和全域變數，儘管兩者的範圍不同而不會發生語法錯誤，但會使人誤解。

【規則3-1-6】變數的名字應當使用“名詞”或者“形容詞＋名詞”。

【規則3-1-7】全域函數的名字應當使用“動詞”或者“動詞＋名詞”（動賓片語）。類的成員函數應當只使用“動詞”，被省略掉的名詞就是對象本身。

【規則3-1-8】用正確的反義片語命名具有互斥意義的變數或相反動作的函數等。

【建議3-1-1】盡量避免名字中出現數字編號，如Value1,Value2等，除非邏輯上的確需要編號。這是為了防止程式員偷懶，不肯為命名動腦筋而導致產生無意義的名字（因為用數字編號最省事）。

【規則3-2-1】類名和函數名用大寫字母開頭的單片語合而成。

【規則3-2-2】變數和參數用小寫字母開頭的單片語合而成。

【規則3-2-3】常量全用大寫的字母，用底線分割單詞。

【規則3-2-4】靜態變數加首碼s_（表示static）。

【規則3-2-5】如果不得已需要全域變數，則使全域變數加首碼g_（表示global）。

【規則3-2-6】類的資料成員加首碼m_（表示member），這樣可以避免資料成員與成員函數的參數同名。

【規則3-2-7】為了防止某一軟體庫中的一些標識符和其它軟體庫中的衝突，可以為各種標識符加上能反映軟體性質的首碼。例如三維圖形標準OpenGL的所有庫函數均以gl開頭，所有常量（或宏定義）均以GL開頭。(在C中不好實現命名空間，為了防止調用的第三方庫中出現相同的強符號重定義基本是通過加首碼來避免，不然又要會被要求重建庫)

【規則4-2-1】不要編寫太複雜的複合運算式。

例如：

      i = a >= b && c < d && c + f <= g + h ;   // 複合運算式過於複雜

【規則4-2-2】不要有多用途的複合運算式。

例如：

d = (a = b + c) + r ; 該運算式既求a值又求d值。

【規則4-2-3】不要把程式中的複合運算式與“真正的數學運算式”混淆。

【規則4-3-1】不可將布爾變數直接與TRUE、FALSE或者1、0進行比較。

【規則4-3-2】應當將整型變數用“==”或“！=”直接與0比較。

【規則4-3-3】不可將浮點變數用“==”或“！=”與任何數字比較。

（float還是double的最小值規範中都有定義，可以看一下）

千萬要留意，無論是float還是double類型的變數，都有精度限制。所以一定要避免將浮點變數用“==”或“！=”與數字比較，應該設法轉化成“>=”或“<=”形式。假設浮點變數的名字為x，應當將   if (x == 0.0)     // 隱含錯誤的比較

轉化為 if ((x>=-EPSINON) && (x<=EPSINON))其中EPSINON(應該是EPSILON，書中字錯了)是允許的誤差（即精度）。

【規則4-3-4】應當將指標變數用“==”或“！=”與NULL比較。

【建議4-4-1】在多重迴圈中，如果有可能，應當將最長的迴圈放在最內層，最短的迴圈放在最外層，以減少CPU跨切迴圈層的次數。

【建議4-4-2】如果迴圈體記憶體在邏輯判斷，並且迴圈次數很大，宜將邏輯判斷移到迴圈體的外面。

【規則4-5-1】不可在for 迴圈體內修改迴圈變數，防止for 迴圈失去控制。

【建議4-5-1】建議for語句的迴圈控制變數的取值採用“半開半閉區間”寫法。

【規則4-6-1】每個case語句的結尾不要忘了加break，否則將導致多個分支重疊（除非有意使多個分支重疊）。

【規則4-6-2】不要忘記最後那個default分支。即使程式真的不需要default處理，也應該保留語句default : break; 這樣做並非多此一舉，而是為了防止別人誤以為你忘了default處理。

很多人建議廢除C++/C的goto語句，以絕後患。但實事求是地說，錯誤是程式員自己造成的，不是goto的過錯。(之前有看過一個開源的協議棧裡也是使用goto到error處，但也僅僅用在這種地方，所以少用、慎用goto語句，而不是禁用)

【規則5-1-1】 盡量使用含義直觀的常量來表示那些將在程式中多次出現的數字或字串。(具名變數也就是const與宏)

【規則5-2-1】在C++ 程式中只使用const常量而不使用宏常量，即const常量完全取代宏常量。

【規則5-3-1】需要對外公開的常量放在標頭檔中，不需要對外公開的常量放在定義檔案的頭部。為便於管理，可以把不同模組的常量集中存放在一個公用的標頭檔中。

【規則5-3-2】如果某一常量與其它常量密切相關，應在定義中包含這種關係，而不應給出一些孤立的值。

【規則6-1-1】參數的書寫要完整，不要貪圖省事唯寫參數的類型而省略參數名字。如果函數沒有參數，則用void填充。

【規則6-1-2】參數命名要恰當，順序要合理。(代碼大全中說的好，參數分為IN、OUT、IN_OUT，具體可以看書中怎麼講的)

【規則6-1-3】如果參數是指標，且僅作輸入用，則應在類型前加const，以防止該指標在函數體內被意外修改。

【規則6-1-4】如果輸入參數以值傳遞的方式傳遞對象，則宜改用“const &”方式來傳遞，這樣可以省去臨時對象的構造和析構過程，從而提高效率。

【建議6-1-1】避免函數有太多的參數，參數個數盡量控制在5個以內。如果參數太多，在使用時容易將參數類型或順序搞錯。(一般前4個參數是存放在寄存器中，多於4個的是存入棧中，小於等於4個參數的函數在取參數方面會比較快)

【建議6-1-2】盡量不要使用類型和數目不確定的參數。

【規則6-2-1】不要省略傳回值的類型。

【規則6-2-2】函數名字與傳回值類型在語義上不可衝突。

【規則6-2-3】不要將正常值和錯誤標誌混在一起返回。正常值用輸出參數獲得，而錯誤標誌用return語句返回。

【建議6-2-1】有時候函數原本不需要傳回值，但為了增加靈活性如支援鏈式表達，可以附加傳回值。

【建議6-2-2】如果函數的傳回值是一個對象，有些場合用“引用傳遞”替換“值傳遞”可以提高效率。而有些場合只能用“值傳遞”而不能用“引用傳遞”，否則會出錯。

【規則6-3-1】在函數體的“入口處”，對參數的有效性進行檢查。(如果所有函數都對有效性進行檢查那必然會降低效率，資料可以分為外部、與內部，外部資料必須進行有效性檢查，內部資料可以不用進行有效性檢查)

【規則6-3-2】在函數體的“出口處”，對return語句的正確性和效率進行檢查。

【建議6-4-1】函數的功能要單一，不要設計多用途的函數。

【建議6-4-2】函數體的規模要小，盡量控制在50行代碼之內。

【建議6-4-3】盡量避免函數帶有“記憶”功能。相同的輸入應當產生相同的輸出。

【建議6-4-4】不僅要檢查輸入參數的有效性，還要檢查通過其它途徑進入函數體內的變數的有效性，例如全域變數、檔案控制代碼等。

【建議6-4-5】用於出錯處理的傳回值一定要清楚，讓使用者不容易忽視或誤解錯誤情況。

【規則6-5-1】使用斷言捕捉不應該發生的非法情況。不要混淆非法情況與錯誤情況之間的區別，後者是必然存在的並且是一定要作出處理的。

【規則6-5-2】在函數的入口處，使用斷言檢查參數的有效性（合法性）。

【建議6-5-1】在編寫函數時，要進行反覆的考查，並且自問：“我打算做哪些假定？”一旦確定了的假定，就要使用斷言對假定進行檢查。

【建議6-5-2】一般教科書都鼓勵程式員們進行防錯設計，但要記住這種編程風格可能會隱瞞錯誤。當進行防錯設計時，如果“不可能發生”的事情的確發生了，則要使用斷言進行警示。

【規則7-2-1】用malloc或new申請記憶體之後，應該立即檢查指標值是否為NULL。防止使用指標值為NULL的記憶體。

【規則7-2-2】不要忘記為數組和動態記憶體賦初值。防止將未被初始化的記憶體作為右值使用。

【規則7-2-3】避免數組或指標的下標越界，特別要當心發生“多1”或者“少1”操作。

【規則7-2-4】動態記憶體的申請與釋放必須配對，防止記憶體流失。

【規則7-2-5】用free或delete釋放了記憶體之後，立即將指標設定為NULL，防止產生“野指標”。

Char * const p = “word”,唯讀常量區不允許被修改

注意當數組作為函數的參數進行傳遞時，該數組自動退化為同類型的指標。

【規則11-2-1】不要一味地追求程式的效率，應當在滿足正確性、可靠性、健壯性、可讀性等品質因素的前提下，設法提高程式的效率。

【規則11-2-2】以提高程式的全域效率為主，提高局部效率為輔。

【規則11-2-3】在最佳化程式的效率時，應當先找出限制效率的“瓶頸”，不要在無關緊要之處最佳化。

【規則11-2-4】先最佳化資料結構和演算法，再最佳化執行代碼。

【規則11-2-5】有時候時間效率和空間效率可能對立，此時應當分析那個更重要，作出適當的折衷。例如多花費一些記憶體來提高效能。

【規則11-2-6】不要追求緊湊的代碼，因為緊湊的代碼並不能產生高效的機器碼。

【建議11-3-1】當心那些視覺上不易分辨的操作符發生書寫錯誤。我們經常會把“＝＝”誤寫成“＝”，象“||”、“&&”、“<=”、“>=”這類符號也很容易發生“丟1”失誤。然而編譯器卻不一定能自動指出這類錯誤。

【建議11-3-2】變數（指標、數組）被建立之後應當及時把它們初始化，以防止把未被初始化的變數當成右值使用。

【建議11-3-3】當心變數的初值、預設值錯誤，或者精度不夠。

【建議11-3-4】當心資料類型轉換髮生錯誤。盡量使用顯式的資料類型轉換（讓人們知道發生了什麼事），避免讓編譯器輕悄悄地進行隱式的資料類型轉換。

【建議11-3-5】當心變數發生上溢或下溢，數組的下標越界。(像VC、GCC編譯器棧溢出保護的編譯選項都是針對上溢檢測的)

【建議11-3-6】當心忘記編寫錯誤處理程式，當心錯誤處理程式本身有誤。

【建議11-3-7】當心檔案I/O有錯誤。

【建議11-3-8】避免編寫技巧性很高代碼。

【建議11-3-9】不要設計面面俱到、非常靈活的資料結構。(靈活對應著複雜度的提高)

【建議11-3-10】如果原有的代碼品質比較好，盡量複用它。但是不要修補很差勁的代碼，應當重新編寫。

【建議11-3-11】盡量使用標準庫函數，不要“發明”已經存在的庫函數。

【建議11-3-12】盡量不要使用與具體硬體或軟體環境關係密切的變數。

【建議11-3-13】把編譯器的選擇項設定為最嚴格狀態。

【建議11-3-14】如果可能的話，使用PC-Lint、LogiScope等工具進行靜態代碼審查。

《C++/C高品質編程指南》筆記