整理一下討論中主張要寫註解的理由,有些比較不必要
1. 程式的why 「寫個一行10~20個字這個method幹麻」
這個可以寫在test spec中。特別是BDD的testing lib的desribe還可以套很多層
應該夠你寫了
2. 責任分配 「// 此功能因某某某要求故加上」
這個應該是寫在commit message,或是commit message上打issue系統的id
從issue可以看到開票的人和理由
3. 商業邏輯 「IFRS制度變換」
提出這個理由的人真的會在註解寫那麼多嗎?
要實作什麼需要應該是PM會寫user story,在commit message給連結就好了
我不會說要不要寫註解是對的還是錯的
每個人環境不同,就必須有不同的行動來對應
不過我的環境會讓我覺得要寫註解是個例外或是最後手段
如果你很需要寫上面三種註解
我會建議你考慮找新工作,你值得更好。
作者:
KeyFSN ( ~☼☽✩☁~ )
2019-10-27 08:30:00我覺得你還是不要太自信...
作者:
yamakazi (大安吳彥祖)
2019-10-27 09:09:00我猜的啦 很多版友的公司其實沒有用issue tracker不然怎麼會有人想把2 3 寫進程式碼註解
很多issue tracker是給上面看的,實際需求又是另一回事
2還有種狀況是開發新功能時發現和舊功能有衝突的特例這時候的commit msg可能會是在說明新功能,除非硬拆一個寫這個區塊的特例commit
作者: onlyeric23 (MiGG) 2019-10-27 12:59:00
雖然是老議題卻仍是能看到濫用註解的案例
作者:
GGFACE (ggface)
2019-10-27 13:48:00我覺得你還是不要太自信...
你連程式碼上面的註解都懶得寫 我就不信你會寫在jiraor test spec
作者: t64141 (榕樹) 2019-10-27 16:20:00
重點是最後一段阿
作者:
alihue (wanda wanda)
2019-10-27 18:23:00多的是,邏輯很簡單,但不知道為何要這麼做,你又不敢拔的
有點好奇你test spec是寫的多好懂會比一段文字還好懂
作者:
senjor (哞哞)
2019-10-28 14:48:00大多時候的確都不需要寫註解,就好像大多時候都不需要加班然而大多數人還是會加班 XDDD
作者:
Ghamu (貓丸)
2019-10-28 20:19:00沒用過 BDD test lib 但如果還要另外翻看的話還是寫註解比較好?