作者superpai (超級白)
看板Soft_Job
標題Re: [討論] 要不要寫註解
時間Sun Oct 27 06:39:41 2019
整理一下討論中主張要寫註解的理由，有些比較不必要
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給連結就好了
我不會說要不要寫註解是對的還是錯的
每個人環境不同，就必須有不同的行動來對應
不過我的環境會讓我覺得要寫註解是個例外或是最後手段
如果你很需要寫上面三種註解
我會建議你考慮找新工作，你值得更好。
--
※ 發信站: 批踢踢實業坊(ptt.cc), 來自: 120.88.154.164 (澳大利亞)
※ 文章網址: https://webptt.com/m.aspx?n=bbs/Soft_Job/M.1572129583.A.FB6.html
1F：→ KeyFSN: 我覺得你還是不要太自信... 10/27 08:30
2F：推 yamakazi: 我猜的啦 很多版友的公司其實沒有用issue tracker 10/27 09:09
3F：推 yamakazi: 不然怎麼會有人想把2 3 寫進程式碼註解 10/27 09:11
4F：推 abccbaandy: 很多issue tracker是給上面看的，實際需求又是另一回 10/27 11:12
5F：→ abccbaandy: 事 10/27 11:12
6F：推 dalconan: 2還有種狀況是開發新功能時發現和舊功能有衝突的特例 10/27 11:57
7F：→ dalconan: 這時候的commit msg可能會是在說明新功能，除非硬拆一個 10/27 11:57
8F：→ dalconan: 寫這個區塊的特例commit 10/27 11:58
9F：推 onlyeric23: 雖然是老議題卻仍是能看到濫用註解的案例 10/27 12:59
10F：推 GGFACE: 我覺得你還是不要太自信... 10/27 13:48
11F：推 anandydy529: 有些公司都用資料夾版控，你還要求開issue 10/27 14:48
12F：→ keke0421: 你連程式碼上面的註解都懶得寫 我就不信你會寫在jira 10/27 15:38
13F：→ keke0421: or test spec 10/27 15:38
14F：→ superpai: 不要太自信是什麼梗？ 10/27 16:02
15F：→ t64141: 重點是最後一段阿 10/27 16:20
16F：噓 alihue: 多的是，邏輯很簡單，但不知道為何要這麼做，你又不敢拔的 10/27 18:23
17F：→ Lomonosov: 有點好奇你test spec是寫的多好懂會比一段文字還好懂 10/27 20:44
18F：→ superpai: test spec 不就是一段文字嗎？ 10/27 20:46
19F：→ Lomonosov: 喔抱歉搞錯了 我以為是test的code 10/27 20:47
20F：→ viper9709: 推一樓 10/27 23:13
21F：→ leolarrel: 我覺得一樓還是不要太自信... 10/28 13:09
22F：推 senjor: 大多時候的確都不需要寫註解，就好像大多時候都不需要加班 10/28 14:48
23F：→ senjor: 然而大多數人還是會加班 XDDD 10/28 14:48
24F：推 Ghamu: 沒用過 BDD test lib 但如果還要另外翻看的話還是寫註解比 10/28 20:19
25F：→ Ghamu: 較好？ 10/28 20:19