寫程式的時候
應該要在程式的輸入參數定義清楚,不要讓這個功能混入不應該有的輸入參數
有時候在工作的時候會看到類似這樣的程式
圖中有兩個API
一個是取得影音資料,另一個是取得影音列表資料
但是輸入參數類別都為同一個RequestParameter
這在維護上就有很大的問題
我們必須思考一個問題
如果有一天程式要交給其他人負責時
無論是菜鳥,資深人員
可以一看就懂 這才是好的程式
不要說還要翻手冊 做文件 (相信我大家都不會想看,這只是增加不該增加的工作成本)
我們從圖中可以看出來這兩個API共用一個RequestParameter Class
但以直覺來看程式 其實看不出那一個API應該會用到那一個輸入的參數
所以我們應該要分別定義不同的輸入參數如圖
取得影音資料的輸入參數為VideoDetailParameter
取得影音列表資料的輸入參數為VideoListParameter
這樣就可以很直覺的就知道那一個API應該輸入什麼參數
那天要把工作交給別人維護開發
也就不用多說明
10分鐘看程式 