編碼規范集錦

jopen 11年前發布 | 23K 次閱讀 編碼規范

編碼規范集錦

真的不知道我的第一篇真正的文章應該以什么為主題。我最終選擇了編碼規范。

編碼規范是什么?

簡單說——編碼規范是一種…規范。通過建立起一種通用的約定和模式,所有人都遵循,以此幫助打造健壯的軟件。

使用編碼規范有什么好處?

有很多好處,包括(不僅限于此):

  1. 保持編碼風格,注釋風格一致,應用設計模式一致
  2. 新程序員,通過熟悉你們的編碼規范,可以更容易、更快速的掌握你們的程序基礎庫。
  3. 減少代碼中bug出現的可能性,因為程序員遇到各種情況時有標準可以簡單的遵循,有現成的參考。
  4. 防止利用晦澀難懂的語言功能創造不良代碼。例如,C++是一種語言猛獸。有些程序員也許會使用諸如模板和異常等語言功能,盡管這些不是很深奧的語言用法,但仍能產生意想不到的性能問題。
  5. 遵循業界廣泛采用的編碼規范更容易獲得輔助工具。
  6. 更容易生成文檔。例如,如果項目中的每個人都按照Doxygen格式寫注釋,你可以輕易的讓程序為你的代碼生成文檔。

使用編碼規范還有其它很多好處,在這里一一列出是不可能的。下面是一些被業界廣泛采用的編碼規范:

  1. 谷歌編碼風格指導 – 包括針對各種語言的編碼風格指導,比如C++,Python,ShellScript,Javascript等。我喜歡谷歌的風格指導的原因是,它給讀者同時提供了這些編碼風格建議的好的和不好的方面。所以請記住,這些編碼規范并不是在任何場合都合適。
  2. 美國太空總署噴氣推進實驗室提供的一些編碼規范指導,當然,他們是開發火箭和宇宙飛船的,所以,他們的指導并不是對所有人都合適,但還是非常有趣的。特別要提到,他們正在起草一個針對Java的編碼規范。
  3. Linux內核編碼風格 – 我很吃驚,他們使用8個tab鍵縮進,要知道,這可是相當寬的縮進。
  4. Perl語言編碼風格指導 – 它提供了Perl程序形式上的風格指導。我最近在網上遇到了各種關于它的爭論,盡管我不喜歡Perl(它有它的缺陷),我仍然為它具有驚人多的文檔而印象深刻。我開始相信它是一個高質量的語言。Perl提供了各種各樣的工具來生成文檔,比如perlcritic
  5. GNU編碼規范 – 主要是格式上的規范,也包含一些關于編程錯誤預防和編程一致性上的最佳實踐方法。
[英文原文: Coding standards ]
來自: 外刊IT評論 http://www.aqee.net/
 本文由用戶 jopen 自行上傳分享,僅供網友學習交流。所有權歸原作者,若您的權利被侵害,請聯系管理員。
 轉載本站原創文章,請注明出處,并保留原始鏈接、圖片水印。
 本站是一個以用戶分享為主的開源技術平臺,歡迎各類分享!