1. 程式人生 > >某日看代碼對代碼可讀性的思考

某日看代碼對代碼可讀性的思考

發現 叠代 命名 提醒 內容 實體對象 方法 的人 功能

緣起

今天去看編譯模塊的代碼,發現實在是看不進去.究其原因,就是設計得有些混亂.這提醒了我,很多時候寫代碼的時候不會註意到一些設計上的問題.在閱讀別人代碼的時候會非常清晰地表現出來.其中有一些典型的問題.

命名之設計模式

比如使用了某種設計模式,但是命名卻沒有符合那個設計模式的規範.導致看了代碼許久,才反應過來:"原來這裏使用了××設計模式啊".

命名之方法內容

經常有些方法叫:"build××".但是其實裏面的內容遠多於build一個實體對象.而是包含了很多查詢.從宏觀上來說可以這麽做,比較確實最後是build了一個Obj.但是在看代碼的時候就容易忽視這個方法的實現.這麽做其實很不好.

風格混搭

一會用Spring註入,一會用init方法,一會用構造方法.總之,一個初始化過程經常在使用不同的方式去構建.當然,這裏恐怕不是某一個人的問題,如果項目參與的人數多了一些,就容易發生這種情況.

調用鏈路過長

這個問題特指由於功能本身的叠代.導致一些調用鏈路越來越長.而實際上有些類本身沒有解決什麽問題.

某日看代碼對代碼可讀性的思考