作者:
sec5566 (sec)
2018-12-27 13:48:31以前上課跟書本都提到寫註解，
但是我看資深同事還有接手的程式碼，
都沒有註解，只有我在寫，
還被主管念過寫註解沒必要，
命名好就夠了，
是我觀念落伍了嗎？
作者: t64141 (榕樹) 2018-12-27 13:54:00
想不寫註解有很多前提，而這個前提不容易達到
作者:
oneheat (等待)
2018-12-27 13:55:00好的代碼很少在寫註解，或者說，code都寫不好了，為什麼會覺得註解會寫的好呢？
有寫註解讓其他人比較省時吧 五六行的程式 一句註解就知道在幹嘛了 有時候哪有時間在那邊一行一行看
作者:
deray (Deray)
2018-12-27 14:11:00寫什麼註解？貼一段來看一下為什麼需要註解
作者:
yyc1217 (somo)
2018-12-27 14:12:00覺得自己寫的很好就不寫註解 這種人很有問題覺得自己寫得不好而寫一堆註解 這種人也很有問題
作者:
iiiii (I take 5)
2018-12-27 14:14:00寫SAMPLE CODE一樣道理，曲高和寡，不是人人懂你的pattern
作者:
yyc1217 (somo)
2018-12-27 14:15:00註解是寫給三個月後的自己看的
不過這樣討論都打高空啦 除非你貼一段被念的程式跟註解
git log是很好用的東西，每個人都在程式碼內註解一段，那到底是要看程式還是看註解
作者:
femlro (母豬教謀神異端審問官1.5)
2018-12-27 14:32:00蘋果官方的code都有註解了 不寫註解超越蘋果
作者:
deray (Deray)
2018-12-27 14:35:00註解！=文件
我覺得至少在func/cls開頭簡單地寫一行這是拿來幹嘛
我是會在比較複雜的判斷上寫註解，以後看比較不用思考
作者: hotdogmc (陳全) 2018-12-27 14:47:00
程式碼本身就是註解
作者:
Argos (Big doge is watching u)
2018-12-27 14:48:00要看情況阿 你是要出API 沒註解行麼？ XD
作者:
Argos (Big doge is watching u)
2018-12-27 14:49:00內部產品程式 註解有必要再加吧 有些潛規則不講很麻煩
自以為寫很好不用寫註解的很多+1 通常就是...自以為
拜託要+1命名到為還是需要註解 因為每個人邏輯不一樣
作者:
deray (Deray)
2018-12-27 15:20:00「當程式碼與註解不符時，你相信什麼？」「The ultimate comment for the code is the code itself「註解是用來『彌補我們用程式碼表達意圖的失敗』」
作者:
knives 2018-12-27 15:21:00推樓上加一，商業邏輯可以另外寫在文件上去交接
作者: dnabossking (少狂) 2018-12-27 15:42:00
把code寫的爛的一b然後跟你說：「我有寫注解」看完注解再看code發現注解根本在誤導（你根本沒有任何方法保證注解的正確性跟易懂）這種人我也見過不少就是了
作者:
exeex (執行檔EX)
2018-12-27 16:05:00先養成"程式即是註解"的code style
作者:
iamshiao (CircleHsiao)
2018-12-27 16:15:00特殊處理寫，其他不寫
作者:
kevin28 (嗯？)
2018-12-27 16:18:00比較複雜的邏輯才會寫
作者:
sean50301 ( (づ′・ω・）づ)
2018-12-27 16:44:00看情境xd 建dl模型註解一下shape 後面的人會很感謝你
作者:
KanoLoa (卡)
2018-12-27 17:06:00當然要寫阿，寫個magic搞搞後人
要拜託 文件也要寫一下不然看到A05_001.java 這樣的沒註解沒文件鬼才知道是要做啥的
至少函式要寫註解說明功能 和input/output吧
作者:
ekin1983 (BBBBBBBBBBBBB)
2018-12-27 17:19:00我的註解通常只寫什麼時間 為何而改(bug 資安 需求單)還有每個function上方註明用途
個人覺得都可以 不管寫不寫註解 只要你的code讓人不好懂 那就有改進的空間 不管是加註解或是重構
作者: PoloHuang (黃保羅) 2018-12-27 18:03:00
寫了註解 結果之後程式有改結果註解沒跟著改
只有複雜的邏輯 或 work around的部分會寫而已
作者:
testPtt (測試)
2018-12-27 18:52:00註解寫得好下次回來改東西就很好進入狀況
那有做 code review 嗎？有確保不解說的情況下對方能看懂嗎？
作者:
testPtt (測試)
2018-12-27 18:59:00尤其像C#註解還有函式超連結功能 追程式碼方便很多
作者: codehard 2018-12-27 19:19:00
可以寫pseudo code當註解
作者:
overhead (overhead)
2018-12-27 19:53:00註解是用來『彌補我們用程式碼表達意圖的失敗
你把code貼上來，不然會淪為各說各話我有看過code寫得還行購簡潔，可是註解寫好幾行的(然後還是很整齊)
菜逼巴CODE都寫不好了還不寫注解 多可憐 沒看過大專案?
作者:
gino0717 (gino0717)
2018-12-27 21:22:00註解應該寫中文還英文 寫英文英文太爛人家看不懂怎麼辦
要寫技術文件，註解還好，code 架構寫得好就夠了
作者:
chuegou (chuegou)
2018-12-27 21:36:00前輩寫得asm沒註解 看到快瘋掉尤其硬體相依的設計 沒註解我甚至該問ME還是EE都不知道
作者:
justben (BEN)
2018-12-27 23:12:00有magic number 的時候 再寫就好了XDD
作者:
xxtuoo (浪費時間不好QQ)
2018-12-27 23:36:00幾乎全部專案都我一個人維護的..寫屁Zzz
作者:
y3k (激流を制するは静水)
2018-12-27 23:42:00不管Code還是註解 有必要才寫 有必要必寫
作者:
molopo (mmm)
2018-12-27 23:44:00你不寫 你同事也不寫 可以公告一下你哪間公司嗎 未來不想去
作者:
lausai (恨怨悲苦憎怒嗔)
2018-12-28 00:26:00註解是需要的 不過註解的用處是說明程式碼作了甚麼 為什麼這麼作 而不是怎麼做不過覺得助解不需要的主管...不塊陶嗎XD
作者:
gino0717 (gino0717)
2018-12-28 00:35:00如果當上主管就可以說 自己的code是clean code 不用註解你們底下基層都是dirty code 都給我寫好寫滿
我比較少寫這段程式碼是幹嘛的，但會寫為什麼要這麼做註解要寫到到如何見仁見智，但有些寫法我不敢苟同...像是說要寫註解好維護，寫一大堆，結果註解沒好好維護或著寫Log時，上行來個//Log，return來個//return然後最近對於一個class裡有滿滿的regin感到很不耐煩
看公司環境，很多時候寫註解commit log是紀錄口頭溝通的事（避免未來被陰）
regin==>region才對像是field和property包一個，public method包一個private method又包一個，method裡可能驗證包一個，實作又一個，實作裡面，可能又是情況包好幾個region...
註解不是通常都拿來寫FIXME: 和WORKAROUND:拿來註釋未解決的問題與等有空再回來解0.0
作者:
kinda (天天)
2018-12-28 01:25:00如果寫的註解能幫其他人省時間就寫。地雷、reference90% 的 code 不需要寫。有時間寫還不如多整理幾次改註解寫太多的 code 很痛苦。註解改完還要檢查很多次...
作者:
bitcch (必可取)
2018-12-28 01:39:00最好的程式碼為程式即是註解 去讀讀code complete就知道了
作者:
kaltu (ka)
2018-12-28 05:27:00可讀性越低的語言越需要註解ASM每個block註解很常見Python本身就是可執行的虛擬碼，註解遠比doc string少見
作者:
bill0205 (善良的小孩沒人愛)
2018-12-28 06:41:00通常只會在寫這個function拿來幹嘛 或是這個檔案的功能
跟可讀性沒甚麼關係..程式即是註解?程式碼都看完了還需要看註解嗎
作者:
jack0204 (Jarbar王朝)
2018-12-28 09:30:00有時候你會看到很神奇的寫法在裡面，還會覺得邏輯很怪這種不寫註解根本不知道它是修了什麼鬼東西才在裡面的
作者: shellback (shellback) 2018-12-28 09:36:00
我是覺得在比較難懂的地方寫一兩行註解有好無壞
作者:
final01 (牛頓運動定律)
2018-12-28 09:45:00會問這問題就是只會寫很廢的註解吧？
話說我有看過每一行function call都寫註解的
作者:
Ekmund (是一隻小叔)
2018-12-28 14:48:00有規範的註解才是好註解 跟log、版本更新資訊一樣
作者:
ggttoo (中華隊加油!!!)
2018-12-28 18:51:00還是需要，不需要就不會有這個功能給你寫了，重點會不會寫
有些hard code的東西不寫註解 誰知道那3小意思註解就是個輔助工具 該用則用 不該用則不用沒有好不好 而是有沒有用對地方就跟if 一樣 看過七八層的if 看了只想翻臉但也不能說用if不對 而是亂用用到沒水準若真的需要用到七八層if也沒啥不對 但有些只要2層
作者:
TAKADO (朕沒給的你不能搶)
2018-12-29 17:13:00註解當然是寫給3個月後的自己看R
作者:
mido (米豆)
2018-12-29 19:12:00不寫註解 你以為你看得懂5.6年前自己寫了三小嗎
作者:
rahit (水元素)
2018-12-29 23:46:00我一般就每個function說一下在幹嘛就好寫的比較複雜的部份才會特別加而且常常自己寫的過幾個月自己也看不懂註解至少讓我找得到哪裡要改
作者: superpandal 2018-12-30 21:13:00
取決於你東西寫的好不好 註解、文檔寫不好那乾脆不要寫 程式碼寫不好乾脆不要寫...? 阿 不是 是打掉重練喜歡寫大而全代碼風格的喜歡用註解來維持代碼可讀喜歡用寫小而精風格代碼的喜歡用簡潔易懂風格來維持代碼可讀性
當你需要在數分鐘內解bug，你會感激自己半年前的註解解
作者: lnmlee 2018-12-31 12:28:00
這總討戰文時不時就會出現