作者mickeyboy (mickey)
看板Soft_Job
標題[請益] 沒註解的專案該如何維護
時間Wed Jul 19 21:16:32 2017
爬了一下版規，如果有觸犯到，再刪文 謝謝
幫朋友代PO
最近接手公司的新專案，結果發現該專案
幾乎完全沒註解，可能一個檔案裡面
註解不超過10個字，也沒手冊
雖然變數名稱那些都是用"有意義的英文"命名
大致上能猜得出"可能是跟什麼有關"
例如薪資單可能是A檔案，但A檔案中又一堆function
目前只能從MVC開始慢慢追，想請問版上的前輩們
如果遇到這種專案維護，有什麼技巧可以快速入手的
問公司的前輩，意思是摸索久了，自然就會記得了
感謝
--
※ 發信站: 批踢踢實業坊(ptt.cc), 來自: 36.234.194.96
※ 文章網址: https://webptt.com/m.aspx?n=bbs/Soft_Job/M.1500470195.A.D26.html
1F：推 RunRun5566: 需要的時候再改，不需要勉強自己全部吸收 07/19 21:26
2F：推 wlul: 個人認為寫code最好能做到"程式本身即註解" 07/19 21:28
3F：→ wlul: 除非某處需要註解當時的spec或不合常規的需求，我才會註解 07/19 21:29
4F：→ wlul: 幾年下來，年輕一輩的還是認為我的程式讀起來沒什麼問題 07/19 21:29
5F：→ wlul: 一點點分享:) 07/19 21:30
6F：推 abc0922001: 從資料流去看吧，按下什麼button，會到哪個function 07/19 21:43
7F：→ abc0922001: 摸透了寫成文件偷偷藏著（X 07/19 21:44
8F：噓 final01: 程式碼不就是最好的註解了... 07/19 21:49
9F：推 sunnyvisit: 資料流+1 從入口到終點整個看過至少知道流程 07/19 21:49
10F：推 ripple0129: Clean code的概念啊，不過怕是Clean code的不註解概 07/19 21:50
11F：→ ripple0129: 念下寫的Code卻不Clean 07/19 21:50
12F：推 panda04056: 一堆人以為自己code很好讀 然後說不用註解= = 07/19 21:54
13F：→ panda04056: 寫的清楚加好的註解就是事半功倍啊 07/19 21:54
14F：→ panda04056: 不然每個人認為的好讀根本天差地遠 07/19 21:55
15F：推 t64141: 我是先找入口點，然後找尾端(存取資料庫)，接著看中間有沒 07/19 22:02
16F：→ t64141: 有粗略歸納出幾層 07/19 22:02
17F：→ t64141: 如果有稍微分層或是分模組，那大概的雛型就有了，接著再慢 07/19 22:03
18F：→ t64141: 慢根據功能點去追細節 07/19 22:03
19F：推 lilicoco520: 從主要button點下去開始追資料流了... 07/19 22:05
20F：推 jj0321: X! 程式碼就是最好的註解無誤 聽前人說明還不如我自己看 07/19 22:24
21F：→ jj0321: 然後還從無註解的舊架構翻成新架構 練功MAX 07/19 22:26
22F：推 fgh81113: 有沒有看過註解錯的程式 這樣我倒不如不要註解 07/19 22:44
23F：→ testPtt: 如果是C#有做summary維護效率差很多 07/19 22:48
24F：推 Ekmund: 你要的是一整個架構的spec吧? 我發現其實這種東西不多 07/19 22:49
25F：→ Ekmund: 而且因為長年修修改改 也未必準確... 07/19 22:49
26F：→ Ekmund: 從流程下去追 問前輩"為什麼這樣處理" 反而比較快 07/19 22:50
27F：→ james732: 半調子而且還跟code不同步的註解才是恐怖 07/19 22:53
28F：噓 blitzran: 程式碼要當註解，也要參數跟方法有好好寫啊 07/19 22:59
29F：→ blitzran: 曾經遇過接手的老專案，class叫a01跟b01這樣的 07/19 23:00
30F：推 lovebridget: 先問用途 從上往下看快太多 07/19 23:12
31F：→ viper9709: 這個只能認命追了 07/19 23:17
32F：→ dreamnook: 邏輯流 07/19 23:51
33F：→ t78973677: 有用框架會比較好追，像react、mvp，沒有就要看他命名 07/20 07:54
34F：→ t78973677: 了 07/20 07:54
35F：噓 kai5566: 二樓根本答非所問....只想說自己的事情 07/20 09:14
36F：→ htury: 靠ide去追code了 07/20 11:45
37F：推 Argos: 少在那邊 99%的程式都爛到無法自我表達好唄 乖乖寫你的註解 07/20 12:44
38F：→ lucky4283: 寫註解不是很基本的概念嗎?為什麼一堆人不寫 07/20 14:30
39F：→ vi000246: clean code的概念是有些人寫了註解就懶得重構 07/20 16:03
40F：→ vi000246: 重構+適度的註解才比較好讀懂 07/20 16:03
41F：→ Argos: 事實是 拿我寫clean code藉口說看程式就好不用寫註解 註解 07/20 16:05
42F：→ Argos: 只會過時的 通常code一點也不clean 07/20 16:05
43F：→ Argos: 連註解都不肯好好維護 哪有心寫clean code？ 07/20 16:06
44F：→ Argos: 而且clean code也沒全反對註解 該解釋的就好好解釋清楚齁 07/20 16:07
45F：→ bobju: 看個案吧~ 不過目前能run得好好的東西就盡量別去動 07/20 16:08
46F：推 kaltu: 沒註解好過註解騙你 07/20 18:16
47F：推 james732: 註解騙人的真的很慘 07/20 18:31
48F：推 kinanson: 有意義的命名跟注解沒啥兩樣，如果你不懂為何要這樣做， 07/20 19:34
49F：→ kinanson: 一樣都看不懂 07/20 19:34
50F：推 xvid: 多半都是自以為易讀實際是爛code 07/20 22:43
51F：→ xvid: 那種懶、隨便的心態寫出來的東西 最後都很多藉口 07/20 22:45
52F：推 nova06091: 因為有些人覺得寫註解很low 07/21 08:05
53F：推 giacch: 你不知道以後程式都給AI寫嗎? 07/21 09:45
54F：→ giacch: 註解只是用來幫助記憶或給不懂的人看的 07/21 09:45
55F：推 f124: 易讀? 哪考慮那麼多 案子先處理掉 接下來就是下個人的問題了 07/21 09:46
56F：→ Argos: 所以說懶就承認 把「會被註解騙」拿來當藉口的 寫不出什麼 07/21 10:14
57F：→ Argos: clean code的啦 賣鬧阿 07/21 10:14
58F：→ airtsubasa: 當一支報表數十個欄位，我寧願用數字排列加上對應清單 07/21 15:14
59F：→ airtsubasa: 還比較好 07/21 15:14
60F：推 prag222: 啥邏輯劉?沒看過有人寫個FUNCTION全部擠一起3000行? 07/21 21:37
61F：推 rice9547: 公司前輩的code都沒註解，但我一目了然 07/21 22:31
62F：推 e2755699: 原來不寫註解是因為懶0.0 07/22 10:05
63F：推 vaper: 在職時滿註解，離職後clean code。這樣有了解嗎~~呵 07/22 18:34
感謝熱心的建議，朋友是說因為是不同團隊
所以風格上有些差異，原團隊雖然命名比較不嚴謹
不過因為都有文件跟架構說明，function也有註解說明
所以才求救看有什麼經驗處理，感謝~
※ 編輯: mickeyboy (36.234.192.141), 07/23/2017 21:08:06
64F：推 f124: 先搞懂那系統是幹麻用的 怎麼用 再來追吧 07/23 22:10