code clean之函數,註釋

code clean

三部分:函數

1.短小:函數要短小,更短小。極長的函數邏輯是不清晰的,讀很長的函數往往會被很多瑣碎的細節分神,好的函數應該是模塊化的。
2.一個函數應該儘量只做並做好一件事。
3.向下規則:代碼的閱讀順序應該是自頂向下的,要讓每個函數後面都跟着位於下一抽象層級的函數。這樣看代碼的時候,向下翻頁就可以了。
4.函數命名:
- 函數越短、功能越集中,就越便於取個好名字。動詞+名詞命名法。
- 別害怕長名稱。長而具有描述性的名稱,要比短而令人費解的名稱好。長而具有描述性的名稱,要比描述性的長註釋要好。
- 命名方式要保持一致,名詞+動詞。
5.函數參數:零參數函數 > 單參數函數 > 雙參數參數 > 三參數參數(避免),參數越少越好
6.結構化編程:
- Dijkstra結構化編程規則:每個函數、函數中的每個代碼塊都應該有一個入口、一個出口。每個函數 只能有一個return語句,循環中不能有break或continue語句,永遠不能由goto
7.避免重複(DRY),儘可能杜絕重複代碼,凡是需要用至少兩次的代碼,給它單獨寫成一個函數
8.寧可變量名長,也不要讓變量名短得讓人無法揣測其含義。
9.命名的時候單詞不要使用縮略的方法,這樣別人是沒法理解你的代碼,寫代碼是讓別人來看的。
10.不同的模塊之間使用空行,這樣代碼閱讀起來比較的清晰。

第四部分:註釋

1.註釋不能美化糟糕的代碼:與其花時間編寫解釋你寫出的糟糕代碼的註釋,不如花時間整理你那糟糕的代碼。
2.用代碼來闡述:用代碼來解釋意圖而不是註釋
3.刪除掉註釋的代碼。

書自己是看過三遍,爲了節約時間,在寫博客的時候借鑑了別人部分文字。
參考文獻
https://www.cnblogs.com/fangpengchengbupter/p/10918165.html

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章