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

看板Soft_Job作者 (超級白)時間4年前 (2019/10/27 06:39), 編輯推噓8(9115)
留言25則, 16人參與, 4年前最新討論串8/9 (看更多)
整理一下討論中主張要寫註解的理由,有些比較不必要 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://www.ptt.cc/bbs/Soft_Job/M.1572129583.A.FB6.html

10/27 08:30, 4年前 , 1F
我覺得你還是不要太自信...
10/27 08:30, 1F

10/27 09:09, 4年前 , 2F
我猜的啦 很多版友的公司其實沒有用issue tracker
10/27 09:09, 2F

10/27 09:11, 4年前 , 3F
不然怎麼會有人想把2 3 寫進程式碼註解
10/27 09:11, 3F

10/27 11:12, 4年前 , 4F
很多issue tracker是給上面看的,實際需求又是另一回
10/27 11:12, 4F

10/27 11:12, 4年前 , 5F
10/27 11:12, 5F

10/27 11:57, 4年前 , 6F
2還有種狀況是開發新功能時發現和舊功能有衝突的特例
10/27 11:57, 6F

10/27 11:57, 4年前 , 7F
這時候的commit msg可能會是在說明新功能,除非硬拆一個
10/27 11:57, 7F

10/27 11:58, 4年前 , 8F
寫這個區塊的特例commit
10/27 11:58, 8F

10/27 12:59, 4年前 , 9F
雖然是老議題卻仍是能看到濫用註解的案例
10/27 12:59, 9F

10/27 13:48, 4年前 , 10F
我覺得你還是不要太自信...
10/27 13:48, 10F

10/27 14:48, 4年前 , 11F
有些公司都用資料夾版控,你還要求開issue
10/27 14:48, 11F

10/27 15:38, 4年前 , 12F
你連程式碼上面的註解都懶得寫 我就不信你會寫在jira
10/27 15:38, 12F

10/27 15:38, 4年前 , 13F
or test spec
10/27 15:38, 13F

10/27 16:02, 4年前 , 14F
不要太自信是什麼梗?
10/27 16:02, 14F

10/27 16:20, 4年前 , 15F
重點是最後一段阿
10/27 16:20, 15F

10/27 18:23, 4年前 , 16F
多的是,邏輯很簡單,但不知道為何要這麼做,你又不敢拔的
10/27 18:23, 16F

10/27 20:44, 4年前 , 17F
有點好奇你test spec是寫的多好懂會比一段文字還好懂
10/27 20:44, 17F

10/27 20:46, 4年前 , 18F
test spec 不就是一段文字嗎?
10/27 20:46, 18F

10/27 20:47, 4年前 , 19F
喔抱歉搞錯了 我以為是test的code
10/27 20:47, 19F

10/27 23:13, 4年前 , 20F
推一樓
10/27 23:13, 20F

10/28 13:09, 4年前 , 21F
我覺得一樓還是不要太自信...
10/28 13:09, 21F

10/28 14:48, 4年前 , 22F
大多時候的確都不需要寫註解,就好像大多時候都不需要加班
10/28 14:48, 22F

10/28 14:48, 4年前 , 23F
然而大多數人還是會加班 XDDD
10/28 14:48, 23F

10/28 20:19, 4年前 , 24F
沒用過 BDD test lib 但如果還要另外翻看的話還是寫註解比
10/28 20:19, 24F

10/28 20:19, 4年前 , 25F
較好?
10/28 20:19, 25F
文章代碼(AID): #1TjCil-s (Soft_Job)
討論串 (同標題文章)
文章代碼(AID): #1TjCil-s (Soft_Job)