Re: [討論] 要不要寫註解

作者: aoksc (重出江湖)   2019-10-26 21:39:33
當然是要寫
但不是每個method都寫
你說的內容感覺比較像summary
summary當然是必寫
你就稍微寫個一行10~20個字這個method幹麻的
也花不到兩分鐘吧
幫別人也避免自己太久沒看忘記了不是很好嗎?
某些走火入魔的人就是拿1的觀點堅持不寫summary
你只要寫了就批評你沒觀念
但實際情況是很多時候根本不是靠命名就能完整說明
尤其是一堆人的英文又很破
我自己是真的很簡單的method不會寫
像是GetUserInfo這種一看就看出來的字義
而且程式碼只有不到十行的話我可能就不會寫
但如果包含了商業邏輯而且程式碼比較長的話我就會寫
還有另外一種就是程式裡面的註解
也是一樣會有抱持著1觀點的北X
堅持要寫註解就是你程式寫的太複雜要重構重寫bala~bala
我認同少寫註解
但不是完全不寫
因為有時候你的程式可能就是因為某些原因不得不這樣寫
或者是因為某些討論之後加了某些程式碼
你不寫的話後面的人根本不曉得為啥流程突然會冒出這段
如果你把它收斂成method的話那就是前面講的summary
花個兩分鐘加個註解
後續維護的人感謝你甚至未來的你也會感謝你
這樣不是很好嗎?
※ 引述《sec5566 (sec)》之銘言:
: 聽過說法是
: 1.寫註解是浪費時間,命名命的好不需要寫
: 2.寫註解方便維護,而且讀中文一定比讀英文快
: 自己是常常忽略註解,
: 不過有空還是會補上,
: 因為程式都只有我在弄,
: 但是當大型系統過一陣子在拿出來改時,
: 就知道不寫註解真的是省小時間花大時間,
: 像是一堆函式傳幾個變數能跑出什麼,
: 還是同樣提資料,這2個提出來差在哪?
: 不寫後面維護的人,就要很辛苦去看裡面,
: 尤其是交接工作,
: 大家會寫註解嗎?
:
作者: npkalala   2019-10-26 22:23:00
精闢推!!
作者: senjor (哞哞)   2019-10-27 02:46:00
個人覺得註解就寫成一般引用外部Lib的時候會看見的那種內容就剛剛好了
作者: Ghamu (貓丸)   2019-10-27 03:30:00
註解不該重複描寫程式碼的內容 類似 ”如果怎樣就怎麼樣”因為註解可能不會被更新 程式碼會 要寫除了程式碼本身以外的意圖 才不會不匹配被誤導
作者: viper9709 (阿達)   2019-10-27 23:09:00
推同感
作者: cat0429 (momo)   2019-10-28 09:16:00
其實不寫註解有個很重要的原因:英文太破寫不出來
作者: lucky4283 (KENNY)   2019-10-30 19:56:00
推這篇,寫註解不是很基本的常識嗎....
作者: as885212   2019-10-31 16:02:00
在現實世界如果只會二分法 真的是蠻好笑的

Links booklink

Contact Us: admin [ a t ] ucptt.com