閱讀400 返回首頁    go 王者榮耀


C++編程規範之0:不要拘泥於小節

不拘泥於小節又名了解那些東西不應該標準化

原則:隻規定需要規定的事情,不要強製施加個人洗好或者過時的做法

應該在每個源文件乃至每個項目中都使用一致的格式,因為同一段代碼中要在集中編程風格直接換來換去是很不舒服的。但是無需在多個項目或者整個公司範圍內強製實施一致的格式。幾種常見的情況如:

  • 不要規定縮進多少,應該規定要用縮進來體現代碼的結構。

    縮進空格的數量可以遵照個人習慣,但是至少在每個文件中應該保持一致。

  • 不要強製行的具體長度,應該保證代碼行的長度有利於閱讀

    可以遵照個人習慣來決定行長,但是不要過長。研究表明,文字長度不超過10個單詞最有利於閱讀。

  • 不要在命名方麵規定過多,應該規定的是使用一致的命名規範

    有兩點是必須的:(1)永遠不要使用“晦澀的名稱”,即以下劃線開始或者包含雙下劃線的名稱;(2)總是使用形如ONLY_UPPERCASE-NAMES的全大寫字母表示宏,不要考慮使用常見的詞或者縮略詞作為宏的名稱。

  • 不要規定注釋風格(除非需要使用工具從特定的體例中提取出文檔)
    應該編寫有用的注釋,盡可能編寫代碼而不是寫注釋,不要在注釋中出現重複寫代碼語義,這樣很容易產生不一致。應該編寫的是解釋方法和原理的說明性注釋。

 

最後更新:2017-04-03 14:54:29

  上一篇:go C++編程規範之1:在高警告級別幹淨利落地進行編譯
  下一篇:go 機房收費係統之防止SQL注入