每一個程序員要遵守的一些優秀編程風格
無論你是業余的還是專業的程序員,正確的編程風格,不但有助于提升軟件產品的功能,還可以明顯減少軟件災難的產生。今天,我們就來探討一下有助于我們獲取更佳編程風格的一些最好的規則。
代碼的可讀性至上
代碼要能可閱讀和可理解,就需要格式化成一致的方式。對函數和變量的命名應有意義,注釋的表達應該簡潔而準確。并且,準確地記錄代碼中所有棘手的部分是十分重要的。你必須清楚軟件程序為什么能工作以及為什么能在所有可能的情況下順利工作的原因。
遵循正確的命名約定是必須的
當需要給類、函數和變量命名時,你需要遵循以下指南:
- 確保特定類名的第一個字母大寫;
- 使用大小寫分離多個單詞的命名;
- 大寫常數名,并使用下劃線分離單詞;
- 確保特定功能和變量名的第一個字母小寫;
- 注意正確使用縮寫。例如,用max而不用maximum。
必要時可使用空格
雖然空格對編譯器是沒有意義的,但是可用于提高代碼的可讀性。舉個例子,你可以在函數間留三個空行。你還可以在函數內使用單獨的空行用于分離關鍵的代碼段。
確保代碼有一定的可維護性
我們需要確保寫出來的代碼,換成另一個程序員來調整功能、修復bug,也是明確易懂的。要將函數中關鍵值用常量來標記,這樣我們就可以隨時根據需要來改變這些常量值。總而言之,代碼必須堅固,能夠處理任何類型的輸入,然后在不崩潰的前提下,提供預期結果。
注釋必須易于理解
注釋應該是有意義的,能夠清晰地解釋所有關于軟件程序的內容。注釋的數量多少無所謂,質量才是關鍵。你需要使用/ *注釋* /的風格來寫注釋,以確保位于每個源文件的頂部。此外,你也可以選擇在注釋中包括你的名字,編寫代碼的日期,以及簡明扼要地說明程序的實際用途。不過,你 可以選擇省略一些功能明顯的注釋。你需要遵循的行內注釋格式為//注釋。
正確使用函數
每一個函數所包含的代碼片段,必須既短又能夠完成特定的任務。不妨將函數當作是“黑盒子”——獨立,又可以有效處理任何類型的輸入。不要忘記這樣一 條經驗規則——即所謂的“Ten Line Rule”,也就是說,一個函數,通常說來,如果超過10行,那就需要以最精煉的方式去簡化。并且,任何重復性的代碼片段都應該被設置為一個單獨的函數。 上述做法不但可縮短程序的長度,還能大大提高其可讀性。
整齊的代碼縮進
縮進在軟件程序的流程控制上起著至關重要的作用。每一個新的while、for、if語句,以及switch結構,都需要縮進代碼。這也可用于一行語句中括號已被省去的情況。例如,假設有if語句,那么相應else語句必須一齊縮進。
結束語
如果你熟悉了這些正確的編程風格,那么編寫軟件程序就會成為一個非常有趣的活動。最后希望本文能對各位有所裨益。如有不同見解,歡迎一起探討。
</div>
譯文鏈接:
http://www.codeceo.com/article/programming-style.html
英文原文:
Want A Proper Programming Style? Here Are Rules You Need To Follow
翻譯作者:
碼農網 – 小峰