程式碼要能可閱讀和可理解，就需要格式化成一致的方式。對函式和變數的命名應有意義，註釋的表達應該簡潔而準確。並且，準確地記錄程式碼中所有棘手的部分是十分重要的。你必須清楚軟體程式為什麼能工作以及為什麼能在所有可能的情況下順利工作的原因。
遵循正確的命名約定是必須的
當需要給類、函式和變數命名時，你需要遵循以下指南：
- 確保特定類名的第一個字母大寫；
- 使用大小寫分離多個單詞的命名；
- 大寫常數名，並使用下劃線分離單詞；
- 確保特定功能和變數名的第一個字母小寫；
- 注意正確使用縮寫。例如，用max而不用maximum。
必要時可使用空格
雖然空格對編譯器是沒有意義的，但是可用於提高程式碼的可讀性。舉個例子，你可以在函式間留三個空行。你還可以在函式內使用單獨的空行用於分離關鍵的程式碼段。
確保程式碼有一定的可維護性
我們需要確保寫出來的程式碼，換成另一個程式設計師來調整功能、修復bug，也是明確易懂的。要將函式中關鍵值用常量來標記，這樣我們就可以隨時根據需要來改變這些常量值。總而言之，程式碼必須堅固，能夠處理任何型別的輸入，然後在不崩潰的前提下，提供預期結果。
註釋必須易於理解
註釋應該是有意義的，能夠清晰地解釋所有關於軟體程式的內容。註釋的數量多少無所謂，質量才是關鍵。你需要使用/ *註釋* /的風格來寫註釋，以確保位於每個原始檔的頂部。此外，你也可以選擇在註釋中包括你的名字，編寫程式碼的日期，以及簡明扼要地說明程式的實際用途。不過，你可以選擇省略一些功能明顯的註釋。你需要遵循的行內註釋格式為//註釋。
正確使用函式
每一個函式所包含的程式碼片段，必須既短又能夠完成特定的任務。不妨將函式當作是“黑盒子”——獨立，又可以有效處理任何型別的輸入。不要忘記這樣一條經驗規則——即所謂的“Ten Line Rule”，也就是說，一個函式，通常說來，如果超過10行，那就需要以最精煉的方式去簡化。並且，任何重複性的程式碼片段都應該被設定為一個單獨的函式。上述做法不但可縮短程式的長度，還能大大提高其可讀性。
整齊的程式碼縮排
縮排在軟體程式的流程控制上起著至關重要的作用。每一個新的while、for、if語句，以及switch結構，都需要縮排程式碼。這也可用於一行語句中括號已被省去的情況。例如，假設有if語句，那麼相應else語句必須一齊縮排。
結束語
如果你熟悉了這些正確的程式設計風格，那麼編寫軟體程式就會成為一個非常有趣的活動。最後希望本文能對各位有所裨益。如有不同見解，歡迎一起探討。
來自：碼農網
評論(1)