一些記錄
- 無論是變量、函數、類的名字都要取有意義的名稱；
- 函數的功能要儘可能保持單一簡單，即單一職責原則；
- 函數的參數個數也不易太多，一般不超過三個，超過三個應該考慮使用類去封裝或者分解函數內容；
- 函數的參數一般都作爲輸入參數，輸出參數儘量修改爲返回值來統一返回；
- 代碼註釋也應該保持簡潔易懂，不要做無意義的註釋，比如，編寫日期，編寫人，版權信息等這些註釋信息都可通過版本控制軟件來體現；
- javadoc註釋一般用於外部接口，內部代碼的註釋一般不建議使用。
一些設計原則
- 單一職責原則 Single Responsibility Principle (SRP)
描述的是每一個類都只負責單一的功能，切不可太多，並且一個類應當儘量的把一個功能做到極致； - 里氏替換原則 Liskov’s Substitution Principle (LSP)
描述的是一個子類應該可以替換掉父類並且可以正常工作； - 接口隔離原則 Interface-segregation Principle (ISP)
描述的是接口最小化原則，強調的是一個接口擁有的行爲應該儘可能的小； - 依賴倒置原則 Dependency Inversion Principle (DIP)
描述的是頂層模塊不應該依賴於底層模塊，二者都應該依賴於抽象類，抽象類不應該依賴於細節，細節應該依賴於抽象； - 迪米特法則 the Law of Demeter (LOD)
描述的是最小知道原則，一個類應該儘量不要知道其他類太多的東西，不要和陌生的類有太多的接觸； - 開放封閉原則 Open-Close Principle (OCP)
描述的是軟件實體（類、模塊、函數等等）應該儘量保持對擴展是開放的，對修改是封閉的。