1. 程式人生 > >(轉)規範你的程式碼編寫風格

(轉)規範你的程式碼編寫風格

轉自原文:https://blog.csdn.net/zhangyuanxuevaq/article/details/79437954 

1、基本規則

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

例如:識別符號最好採用英文單詞或其組合,便於記憶和閱讀。切忌使用漢語拼音來命名。程式中的英文單詞一般不會太複雜,用詞應當準確。例如不要把CurrentValue寫成NowValue。

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

【規則1-3】命名規則儘量與所採用的作業系統或開發工具的風格保持一致。

 例如Windows應用程式的識別符號通常採用“大小寫”混排的方式,如AddChild。而Unix應用程式的識別符號通常採用“小寫加下劃線”的方式,如add_child。別把這兩類風格混在一起用。

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

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

【規則1-7】全域性函式的名字應當使用“動詞”或者“動詞+名詞”(動賓片語)。類的成員

函式應當只使用“動詞”,被省略掉的名詞就是物件本身。

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

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

2、簡單的Windows應用程式命名規則

【規則2-1】類名和函式名用大寫字母開頭的單詞組合而成

【規則2-2】變數和引數用小寫字母開頭的單詞組合而成。

問:物件和結構體成員命名規則?

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

【規則2-4】靜態變數加字首s_(表示static)。

【規則2-5】如果不得已需要全域性變數,則使全域性變數加字首g_(表示global)。

【規則2-6】類的資料成員加字首m_(表示member),這樣可以避免資料成員與成員函式的引數同名。

【規則2-7】為了防止某一軟體庫中的一些識別符號和其它軟體庫中的衝突,可以為各種識別符號加上能反映軟體性質的字首。例如三維圖形標準OpenGL的所有庫函式均以gl開頭,所有常量(或巨集定義)均以GL開頭。

專案經驗:

1、所有vector類容器命名在最後都加上Gather,set類容器命名最後面都加上Set

2、結構體變數以t開頭

3、指標以p開頭

4、臨時變數以temp開頭