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

看板Soft_Job作者 (重出江湖)時間6年前 (2019/10/26 21:39), 編輯推噓6(6推 0噓 4→)
留言10則, 7人參與, 6年前最新討論串6/9 (看更多)
當然是要寫 但不是每個method都寫 你說的內容感覺比較像summary summary當然是必寫 你就稍微寫個一行10~20個字這個method幹麻的 也花不到兩分鐘吧 幫別人也避免自己太久沒看忘記了不是很好嗎? 某些走火入魔的人就是拿1的觀點堅持不寫summary 你只要寫了就批評你沒觀念 但實際情況是很多時候根本不是靠命名就能完整說明 尤其是一堆人的英文又很破 我自己是真的很簡單的method不會寫 像是GetUserInfo這種一看就看出來的字義 而且程式碼只有不到十行的話我可能就不會寫 但如果包含了商業邏輯而且程式碼比較長的話我就會寫 還有另外一種就是程式裡面的註解 也是一樣會有抱持著1觀點的北X 堅持要寫註解就是你程式寫的太複雜要重構重寫bala~bala 我認同少寫註解 但不是完全不寫 因為有時候你的程式可能就是因為某些原因不得不這樣寫 或者是因為某些討論之後加了某些程式碼 你不寫的話後面的人根本不曉得為啥流程突然會冒出這段 如果你把它收斂成method的話那就是前面講的summary 花個兩分鐘加個註解 後續維護的人感謝你甚至未來的你也會感謝你 這樣不是很好嗎？ ※ 引述《sec5566 (sec)》之銘言： : 聽過說法是 : 1.寫註解是浪費時間，命名命的好不需要寫 : 2.寫註解方便維護，而且讀中文一定比讀英文快 : 自己是常常忽略註解， : 不過有空還是會補上， : 因為程式都只有我在弄， : 但是當大型系統過一陣子在拿出來改時， : 就知道不寫註解真的是省小時間花大時間， : 像是一堆函式傳幾個變數能跑出什麼， : 還是同樣提資料，這2個提出來差在哪？ : 不寫後面維護的人，就要很辛苦去看裡面， : 尤其是交接工作， : 大家會寫註解嗎？ : ----- : Sent from JPTT on my Sony H4331. -- ※ 發信站: 批踢踢實業坊(ptt.cc), 來自: 150.117.240.188 (臺灣) ※ 文章網址: https://www.ptt.cc/bbs/Soft_Job/M.1572097176.A.EE3.html
推
10/26 22:23, 6年前 , 1F
精闢推！！
10/26 22:23, 1F
推
10/27 02:46, 6年前 , 2F
個人覺得註解就寫成一般引用外部Lib的時候會看見的那種
10/27 02:46, 2F
→
10/27 02:46, 6年前 , 3F
內容就剛剛好了
10/27 02:46, 3F
推
10/27 03:30, 6年前 , 4F
註解不該重複描寫程式碼的內容 類似 ”如果怎樣就怎麼樣”
10/27 03:30, 4F
→
10/27 03:30, 6年前 , 5F
因為註解可能不會被更新 程式碼會 要寫除了程式碼本身以外
10/27 03:30, 5F
→
10/27 03:30, 6年前 , 6F
的意圖 才不會不匹配被誤導
10/27 03:30, 6F
推
10/27 23:09, 6年前 , 7F
推同感
10/27 23:09, 7F
→
10/28 09:16, 6年前 , 8F
其實不寫註解有個很重要的原因：英文太破寫不出來
10/28 09:16, 8F
推
10/30 19:56, 6年前 , 9F
推這篇，寫註解不是很基本的常識嗎....
10/30 19:56, 9F
推
10/31 16:02, 6年前 , 10F
在現實世界如果只會二分法 真的是蠻好笑的
10/31 16:02, 10F
‣ 更多 aoksc 的文章
文章代碼(AID): #1Tj4oOxZ (Soft_Job)
討論串 (同標題文章)
本文引述了以下文章的的內容：
完整討論串 (本文為第 6 之 9 篇)：
排序： 最新先 | 最舊先 | 留言數
在新視窗開啟完整討論串 (共9篇)
‣ 更多 aoksc 的文章
文章代碼(AID): #1Tj4oOxZ (Soft_Job)