關於程式碼的編寫風格問題
關於程式碼的編寫風格問題
這裡主要說以下幾項
- 匈牙利命名法
- 關於空格的使用
- 關於註釋
1.匈牙利命名法
匈牙利命名法是一種程式設計時的命名規範。基本原則是:變數名=屬性+型別+物件描述
屬性部分:
g_ 全域性變數
c_ 常量
m_ c++類成員變數
s_ 靜態變數
型別部分:
陣列 a
指標 p
函式 fn
無效 v
控制代碼 h
長整型 l
布林 b
浮點型(有時也指檔案) f
雙字 dw
字串 sz
短整型 n
雙精度浮點 d
計數 c(通常用cnt)
字元 ch(通常用c)
整型 i(通常用n)
位元組 by
字 w
實型 r
無符號 u
描述部分:
描述部分就是根據具體情況對這個變數命名了,一般是這個變數所表示的含義的英文單詞的縮寫的拼接,其中多個單詞時,每個單詞或者其縮寫的首字母大寫,縮寫以及單詞要能夠見名知其意
2.關於空格的使用
-
函式名之後不要留空格,緊跟左括號‘(’,以與關鍵字區別,關鍵字之後要留空格。象const、virtual、inline、case 等關鍵字之後至少要留一個空格,否則無法辨析關鍵字。象if、for、while等關鍵字之後應留一個空格再跟左括號‘(’,以突出關鍵字。
-
‘,’之後要留空格,如Function(x, y, z)。如果‘;’不是一行的結束符號,其後要留空格,如for (initialization; condition; update)。
-
賦值操作符、比較操作符、算術操作符、邏輯操作符、位域操作符,如“=”、“+=” “>=”、“<=”、“+”、“*”、“%”、“&&”、“||”、“<<”,“^”等二元操作符的前後應當加空格。一元操作符如“!”、“~”、“++”、“–”、“&”(地址運算子)等前後不加空格。象“[ ] ”、“.”、“->”這類操作符前後不加空格。
3.關於註釋的位置
註釋一般用 /* … */ 或者 // 來進行說明。函式,程式檔案,結構體等的註釋一般寫在相應的實體的上面;變數挑選重要的,難以理解的,意義比較特殊的進行註釋,寫在後面即可。註釋往往是說明兩個東西:
- 這個東西是什麼
- 這個東西實現什麼功能