最近大概讀了一遍代碼整潔之道,感覺自己目前能想到的需要改進的地方包括:
1. 註釋
在寫代碼的時候很喜歡寫一堆註釋出來,主要還是爲了理清楚思路,然後便於後續再看的時候來理解當時爲什麼這麼做。
但是通過更合理的函數命名可以解決。同時過期的註釋也需要及時刪掉。避免影響後續開發的思路。目前項目中有部分未刪掉感覺是之前的同事留下來的,會有點不敢動。
2. 函數
函數的命名,應該直接可以表明該函數的權責
函數的輸入參數也需要注意,過多或者參數類型相同時,可能會導致問題。感覺同樣類型的參數,很容易會寫錯位置。
3. 格式
之前沒有明確瞭解過格式方面的規則,看過書之後,才注意垂直格式和橫向格式,也是自己需要調整的地方。
比如:封包聲明、導入聲明和函數之間的空白行。多個函數之間的順序(某個函數調用了另外一個,應該放到一起,調用者應該在被調用者上面)。概念相關的代碼也應該放在一起,相關性越強,距離越近。
後續有時間在讀一遍,希望有更多的體會吧。