《程式碼整潔之道》讀後感
阿新 • • 發佈:2022-05-27
有意義的命名
- 命名有意義,避免使用process, manager這種可有可無的,不夠具象化的命名,當然,更不能有誤導性的名稱
- 區分度要高,同樣,一些data,info這種區分度較差,同時,更利於搜尋
- 在強型別語言中,避免通過名稱來表示型別
- less is more: 如果兩個名稱表達的意思一樣,那麼選擇更短的
- 類:名詞或名詞短語;函式:動詞或者動詞短語
- 保證命名的一致性,對含義接近的詞保證一致性,或者統一用其中一個。
- 命名儘量能夠貼近業務領域的專有名稱
- 提供語境,通過類的方式更好,或者名稱加字首,不可濫用。
函式
- 函式應當簡短,語義明確,只做一件事
- 避免多層巢狀,不要超過2層
- 只做一件事:一件事的定義為:在函式名稱的抽象層級下完成一件事,函式中為這一件事情的步驟。函式中的所有語句都要位於同一抽象層級下面。
- 函式程式碼位置,自頂向下的層級
- 函式引數:越少越好
- 儘可能遵循一元函式的兩種普遍形式
- 函式引數中的標識引數,慎用,容易違反只做一件事情
- 抽離try_catch,專注只做一件事情
註釋
- 糟糕程式碼不能用註釋掩埋,重構程式碼
- 好的註釋:法律資訊,提供資訊,意圖解釋,警示,todo,放大重要性
- 壞的註釋:廢話(沒有資訊量)
- 能用程式碼說明的事情,別用註釋
格式
團隊一致的風格
語言本身的風格