高質量C/C++程式設計指南總結(三)—— 命名規則

墨小语發表於2024-07-14
  • 識別符號應當直觀,可望文知義。
  • 識別符號的長度應當符合“min-length && max-information” 原則。
  • 命名規則儘量與所採用的作業系統或開發工具的風格保持一致。
  • 程式中不要僅靠大小寫區分相似的識別符號。
  • 程式中不要出現識別符號完全相同的區域性變數和全域性變數。
  • 變數的名字應當使用“名詞”或者“形容詞+名詞”的結構。
  • 用正確的反義片語命名具有互斥意義的變數或相反動作的函式等。
  • 儘量避免名字中出現數字編號,如 Value1,Value2 等,除非邏輯上的確需要編號。
  • 全域性函式的名字應當使用“動詞”或者“動詞+名詞”(動賓片語)。類的成員函式應當只使用“動詞”,被省略掉的名詞就是物件本身。

  • 類名和函式名用大寫字母開頭的單片語合而成。
  • 變數和引數用小寫字母開頭的單片語合而成。
  • 常量全用大寫的字母,用下劃線分割單詞。
  • 靜態變數加字首 s_(表示 static)。
  • 如果不得已需要全域性變數,則使全域性變數加字首 g_(表示 global)。
  • 類的資料成員加字首 m_(表示 member),這樣可以避免資料成員與成員函式的引數同名。
  • 為了防止某一軟體庫中的一些識別符號和其它軟體庫中的衝突,可以為各種識別符號加上能反映軟體性質的字首。

例如三維圖形標準 OpenGL 的所有庫函式均以 gl 開頭,所有常量(或宏定義)均以 GL 開頭。

相關文章