編碼規(guī)范集錦
作者:佚名
簡(jiǎn)單說——編碼規(guī)范是一種…規(guī)范。通過建立起一種通用的約定和模式,所有人都遵循,以此幫助打造健壯的軟件。
真的不知道我的第一篇真正的文章應(yīng)該以什么為主題。我最終選擇了編碼規(guī)范。
編碼規(guī)范是什么?
簡(jiǎn)單說——編碼規(guī)范是一種…規(guī)范。通過建立起一種通用的約定和模式,所有人都遵循,以此幫助打造健壯的軟件。
使用編碼規(guī)范有什么好處?
有很多好處,包括(不僅限于此):
- 保持編碼風(fēng)格,注釋風(fēng)格一致,應(yīng)用設(shè)計(jì)模式一致
- 新程序員,通過熟悉你們的編碼規(guī)范,可以更容易、更快速的掌握你們的程序基礎(chǔ)庫(kù)。
- 減少代碼中bug出現(xiàn)的可能性,因?yàn)槌绦騿T遇到各種情況時(shí)有標(biāo)準(zhǔn)可以簡(jiǎn)單的遵循,有現(xiàn)成的參考。
- 防止利用晦澀難懂的語言功能創(chuàng)造不良代碼。例如,C++是一種語言猛獸。有些程序員也許會(huì)使用諸如模板和異常等語言功能,盡管這些不是很深?yuàn)W的語言用法,但仍能產(chǎn)生意想不到的性能問題。
- 遵循業(yè)界廣泛采用的編碼規(guī)范更容易獲得輔助工具。
- 更容易生成文檔。例如,如果項(xiàng)目中的每個(gè)人都按照Doxygen格式寫注釋,你可以輕易的讓程序?yàn)槟愕拇a生成文檔。
使用編碼規(guī)范還有其它很多好處,在這里一一列出是不可能的。下面是一些被業(yè)界廣泛采用的編碼規(guī)范:
- 谷歌編碼風(fēng)格指導(dǎo) – 包括針對(duì)各種語言的編碼風(fēng)格指導(dǎo),比如C++,Python,ShellScript,Javascript等。我喜歡谷歌的風(fēng)格指導(dǎo)的原因是,它給讀者同時(shí)提供了這些編碼風(fēng)格建議的好的和不好的方面。所以請(qǐng)記住,這些編碼規(guī)范并不是在任何場(chǎng)合都合適。
- 美國(guó)太空總署噴氣推進(jìn)實(shí)驗(yàn)室提供的一些編碼規(guī)范指導(dǎo),當(dāng)然,他們是開發(fā)火箭和宇宙飛船的,所以,他們的指導(dǎo)并不是對(duì)所有人都合適,但還是非常有趣的。特別要提到,他們正在起草一個(gè)針對(duì)Java的編碼規(guī)范。
- Linux內(nèi)核編碼風(fēng)格 – 我很吃驚,他們使用8個(gè)tab鍵縮進(jìn),要知道,這可是相當(dāng)寬的縮進(jìn)。
- Perl語言編碼風(fēng)格指導(dǎo) – 它提供了Perl程序形式上的風(fēng)格指導(dǎo)。我最近在網(wǎng)上遇到了各種關(guān)于它的爭(zhēng)論,盡管我不喜歡Perl(它有它的缺陷),我仍然為它具有驚人多的文檔而印象深刻。我開始相信它是一個(gè)高質(zhì)量的語言。Perl提供了各種各樣的工具來生成文檔,比如perlcritic。
- GNU編碼規(guī)范 – 主要是格式上的規(guī)范,也包含一些關(guān)于編程錯(cuò)誤預(yù)防和編程一致性上的最佳實(shí)踐方法。
英文原文:Coding standards
責(zé)任編輯:林師授
來源:
外刊IT評(píng)論