[閒聊] 寫code不加註解真的很顧人怨嗎

[ianlin1216 (伊恩可可)]

餓死抬頭
https://i.imgur.com/3QcIsVN.jpeg
本魯不是資工系的啦
所以不知道寫程式不加註解會有多嚴重
想請問相關從業的鄉民
實務上遇到這種情況真的很賭爛嗎

乾五西恰

--
※ 發信站: 批踢踢實業坊(ptt.cc), 來自: 220.134.201.122 (臺灣)
※ 文章網址: https://www.ptt.cc/bbs/C_Chat/M.1735122042.A.9F8.html
推 llabc1000: 不加註解的一定是超級有能的傢伙
→ killme323: 這就一樣兩派人士在吵啊
→ llabc1000: 我自己寫的東西不加註解半年後我就不知道它在幹嘛了
推 sunlockfire: 超嚴重，因為幾個月後會連寫的人可能都看不懂
推 tk13os: 前提是code寫的讓人看不懂，還不加註解
→ linzero: 接手的很麻煩，要多花時間理解
→ killme323: 遇過同事是說你要寫註解才能看懂表示寫得爛的
推 aet68933: 還有只把註解當分隔線用的XD
推 webermist: 大概跟大便不沖水一樣的等級
→ LawLawDer: 歷史本文
推 henry1234562: 看複用性
→ awenracious: 寫的爛又不註解的真的該死
→ tk13os: 就算是自己寫的也可能幾個月後看不懂
→ killme323: 我自己是沒意見 看主管(
推 HJC6666: 不一定 要看是不是寫垃圾
→ henry1234562: 註解就是為了這段以後需要改時要用的
推 gagacrow: 寫得好就不太需要 太多註解反而更難讀
→ henry1234562: 如果你很清楚這東西就是這次用完就丟的 就沒差
推 pot1234: 比註解寫的像日記隨筆的好一點
→ gagacrow: 更慘的是註解沒有維護的  地獄模式
→ linzero: 函式參數名稱取的有其意義也算是種註解
推 sniperex168: 連自己都不一定看的懂了
推 ayianayian: 除非你的變數名稱取得一目了然
→ yuizero: 我直接給你一個題目  a + b = 5
→ yuizero: 然後告訴你 a 和b都是一個正整數 而且在設計者心中是一
→ yuizero: 個唯一解。就這樣
→ grtfor: 不是，是註解內容與事實不符，成年累月不刪的錯誤訊息誤導
推 OSDim: 這垃圾是誰寫的，喔 是我==
→ kirimaru73: 寫得極好可以不加註解 這是真的
→ kirimaru73: 不過你們這些庸才不要隨便就自認為寫得很好嘛
→ ayianayian: 要不然三個月後你會抱怨三個月前的自己
→ grtfor: 當你分析半天發現註解在搞你，你會更生氣
推 sunshinecan: 看可讀性 像變數都命名無意義a,b,c的不加註解就很糟
推 AMTS: 寫得好其實不需要太多註解
→ AMTS: 把說明文件寫好還比較重要
→ yuizero: 好。請問。當你急用。必須知道a b是什麼時。你會不會很
→ zore14563: 會不寫註解，八成是是能力很強的g8人= =
→ yuizero: 幹設計者不註解a b是多少？
推 nahsnib: 顧不顧人怨先不論，一個月後你就會恨自己了
→ kirimaru73: 也有這種大家都苦笑的案例
→ kirimaru73: https://i.meee.com.tw/T24DsDn.png
→ moebear: 註解不改版的才是==
推 zelda123: 都要2025了誰還寫註解
→ killme323: what the fuck? 笑死
推 arrenwu: 現在PR如果是我當reviewer 除非是連白癡都一眼能看出來
推 ilovenatsuho: 我覺得比較需要註解的註解
→ arrenwu: 的code，不然我一定要求寫一堆註解 有些我甚至會希望
→ arrenwu: 寫得像作文一樣
→ hoe1101: 不會
→ kirimaru73: 認真說的話，在團隊合作時，寫的code讓別人能看懂是
→ kirimaru73: 你的責任，但你不一定要用註解的方式
→ killme323: 你看推文不就分兩派了XD
→ arrenwu: 現在有了LLM之後 程式碼的註解用途比以前更多了
推 BSpowerx: 會分不清abc幹嘛已經不是註解問題了，而是他媽不要用abc
→ su4vu6: 自己都會忘記的東西 要給別人猜 試著理解你當時在想啥
推 tooperfect: 跟投影片只貼圖一樣靠北
→ su4vu6: 就很麻煩 所以才要註解
推 orze04: 寫的好的話還不算太嚴重
→ shadow0326: 真的有註解焦慮就請copilot幫忙寫就好
→ TSMCfabXX: 看老闆在不在意
推 Porops: 確實是寫得好就不用註解，但如果是長期營運的專案，很難
→ Porops: 全部都是好code
→ arrenwu: 很多時候註解不是只是寫 還要人看得懂
推 lucky0417: 現在看你可能覺得自己寫得很好 但十年後你再看可能至少
→ lucky0417: 要花半天來重讀 回想還不夠惹人厭哦
→ arrenwu: 確實是寫得好就不用註解 <--- 這句話本身就不可證偽幹話
→ su4vu6: 註解寫得不好 確實會讓你解讀錯 也是個問題
推 ccococo: 看情況，就算你真的不想寫也要把變數名稱設定好
→ orze04: 最爛的是code改了，註解還沒改，草你媽
推 BF109Pilot: 我有在註解裡連載過偵探小說
→ shadow0326: print("hello")  # 印出 hello
→ arrenwu: PR送出來的時候 幾乎是唯一你有機會要求撰寫者解釋code
→ orze04: 爛code+錯的註解比單純沒註解更垃圾
→ lucky0417: 改了程式註解沒改更痛苦是真的 一個誤導可能一天就過去
推 ghgn: 不加註解讓其他人看不懂 這樣公司也不敢炒你
→ lucky0417: 了
→ arrenwu: 在幹嘛的時候，那時候就要盡量要求寫得又多又詳盡
→ arrenwu: 甚至我幫忙寫註解都無妨
推 zelda123: clean code 第四章就是在叫你各位別寫註解了
推 wifi: 大概跟聯絡簿不簽名一樣
→ arrenwu: "這之後會寫個詳盡的document"=謊言
推 jeremy7986: 你如果變數名稱取什麼a b c i j x 三小的 最好就給我
→ jeremy7986: 寫註解
推 MelShina: 你之後自己也會看不懂
推 jerryjerry9: 不下註解我隔週就忘記我寫了啥 哭
→ morichi: commit log有寫好就好
推 RageDoors: 不只是寫code的會需要註解啊，有些管線配得超複雜的又
→ RageDoors: 不加個標註，真的下個月就忘記是幹嘛的了
推 cutearia: 除非有什麼特別的問題要提醒 不然正常都不寫的吧
→ jeremy7986: 尤其是一堆magic number 又不寫註解為什麼這邊要
→ jeremy7986: 帶入100 那邊要帶入3000 最後就是一直在通靈程式碼
→ s2500205: 不寫註解一陣子後，連作者都不知道那段程式是在幹嘛的
→ ilovenatsuho: 要有改版紀錄，就算別人不看code，也要知道改了啥
→ arrenwu: AMTS: 把說明文件寫好還比較重要 <--- 註解都寫不好的，
推 hoe1101: 要加寫註解，那簽薪水合約也要該加錢
→ arrenwu: 真的不要期待對方會寫什麼說明文件
推 kirimaru73: what the fuck那個案例，經典之處在於
→ kirimaru73: 那是一個超級棒的變數搜尋起始值，但又不是數學上最
→ kirimaru73: 佳的 (有一點偏差，但也夠好用了)
→ kirimaru73: 然後寫的人沒說他是怎麼找到這個值的 接手的也問不到
推 rabbithouse: 註解OK，但我覺得code以外的東西像是文件log啥的有寫
→ rabbithouse: 清楚我覺得比較重要
推 trtrtradam: 至少節省人家看懂你在寫三小的時間啊
推 sunshinecan: 命名真的難 寫詳細就很冗長 簡寫又最好另外加註解
推 akway: 商業機密
→ hoe1101: 如果是給自己看懂的註解那其實就不是註解，是自我提醒而
→ hoe1101: 已
→ arrenwu: 寫說明文件這種事情，只有 騙子 和 菁英 在講
推 langeo: 不寫也會害到自己吧 寫了幾千行後自己也會忘記
推 tang0710: 最好的code是能直接看懂 但一般人就給我乖乖寫註解
推 aegius1r: 陳年code最快樂的是註解一堆都跟code合不起來
→ arrenwu: PR Approver還有立場要求對方寫更多註解；程式碼送進去
→ Ceferino: 現在應該沒什麼差了，直接丟AI
→ arrenwu: Repo之後 她不爽寫文件或註解你絕對沒輒
→ sarafciel: 可是快速反方根算法是真的就只能那樣寫啊 而且那東西就
→ sarafciel: 算寫了註解也未必一般水準的工程師就看得懂XD
噓 idow: 他這邊不是講寫死代碼嗎 想講hard code那種的吧
推 crazyanight: 覺得可以完全不加的真的有在寫嗎 久了你連自己寫的
→ crazyanight: 都看不懂
推 Giornno: 公司祖傳屎山代碼不加註解，敬請見證
推 lucky0417: 能直接看懂的code本身就不是什麼大東西，上萬行的你看
→ lucky0417: 懂要多久
推 Jameshunter: 變數寫的很直白就沒差 最哭的是全用a1 a2這種的
→ arrenwu: 有AI工具之後註解差得更多
推 CowBaoGan: 不寫信不信一個月後回來看連你自己都看不懂
→ crazyanight: 至少一些關鍵/難懂的部分要寫
→ linzero: what the fuck那個是較低運算量下求得足夠有效的近似值吧
→ letmesee3085: 現在可以叫chat gpt幫你加
→ oselisdu: 什麼一個月 六日放假回來就不認得了
→ Jameshunter: 當然模組是一定要寫這是在幹啥就是了
推 jay905035: #我前面的都沒寫 我當然也不寫囉
推 arrenwu: 現在有不少AI工具是可以讀了你的repo之後扮演像小幫手的
→ arrenwu: 身分回答你很多廣泛問題。這種有沒有註解就會差超級多
→ elia0325: 到時連自己都看不懂就好笑了
推 antinua: 足以放進柯南世界的殺人動機
→ arrenwu: 沒有註解的code，AI就只能給些罐頭回答
→ arrenwu: 你一個 enum class 註解只寫一行或不寫當然無妨啦
推 RandyOrlando: 不寫的話自己都會忘記個八成
→ shadow0326: 我看過註解英文文法爛到看不懂的 也看過非ASCII註解然
→ shadow0326: 後亂碼的 歡樂無限
推 fireleo: 現在AI可以幫你生註解
推 Dnight: 有時候有問題的不是邏輯看不懂，是為什麼要有這段邏輯
推 S04870487: 我在弄公司老舊程式的CODE 一堆糞CODE不註解
推 hakosaki: 有兩派 一派是命名的好的不用寫 另一派是最好給我寫爛
→ hakosaki: ，我覺得加減都要寫，有些寫死在程式裡面的 還有歷史故
→ hakosaki: 事 最好都留著，免得到時候要考古
推 Pocer: 自己寫的不加註解你離開半年再碰都不知道自己在幹啥
→ S04870487: 寫得好就不用註解的標準是啥?一堆自以為寫得好的
推 kirimaru73: 現實公司就沒有真的在提倡把code寫好寫到不用註解的
→ kirimaru73: 你要用這個藉口不寫註解，到時候在公司天花板飛來飛
→ kirimaru73: 去就不要該該叫
推 andy79323: 設無意義變數讓後面的猜
推 Peurintesa: 這個看能力分階段耶 寫的好的確不用太多註解也能看懂
→ linzero: AI現在問題是，你不太懂的，AI也不懂時會瞎掰唬的你以為
→ linzero: 他講的是正確的吧
推 Jameshunter: 你們別再瞎吹AI惹 新進來的搞出一大堆炸彈 被炸死還
推 RINPE: 不會 能力差的才寫
→ Jameshunter: 拿出來報告說窩不知道
推 lucky0417: 上面那個邏輯可能跟一些老舊硬體有關 這種又更痛苦了
→ lucky0417: 你不測根本不會知道
推 LipaCat5566: 資料庫欄位不寫說明才頭痛 名稱看不出用途只能通靈
→ Peurintesa: 不太可能完全不寫 就大概寫一下這段程式在幹嘛就好
推 PatlaborGao2: 自己寫的作文 會自己加上注釋嗎？
→ Peurintesa: 總不可能每寫一行就要寫註解吧==
推 data99553: 你有自信一年後還看得懂的別人基本上也有機會看懂
→ data99553: ，這樣不寫當然沒關係
推 kirimaru73: code和作文等級不同 code是一種魔法
推 BC0710: 不註解變數名又亂取的應該要被抓去關
推 terry955048: 所以寫CODE並不是同一類功能9成一樣套公式的東西嗎??
→ dreamnook2: 實際上是看情況 很多code是顧名思義的在寫
→ linzero: 有的BUG是兼容性問題，這種可能就沒有啥原因邏輯，因為
→ arrenwu: code 不是作文 註解才是作文
→ terry955048: 因此還需要加上註解才看得懂?
→ linzero: 配合的程式、裝置就是這樣搞，也只能特定方式因應
推 GOFEN: 傻了嗎？ 註解是給自己看的，給別人的都是鳥註解
→ S04870487: 一堆莫名的邏輯又不敢去刪除他怕是有用的
→ GOFEN: 不然怎麼再賺一筆
推 zxc2331189: 現在都丟ai看了
→ kirimaru73: 只在一個層面上做單純一件事的code是這樣
→ kirimaru73: 但現實在跑的code可能是100層疊起來的邏輯運作
推 abadjoke: 自己寫的都不一定看得懂了更何況別人寫的
推 k5545332: 真的，很多商業邏輯很複雜，文件也不見得齊全，接手的
→ k5545332: 人真的很痛苦
推 aegius1r: //企劃說要這樣做
推 Jameshunter: 幾百行變數名有寫直白是能不用註解拉 可是超過這數量
推 TCPai: 複雜的真的需要註解阿，主建構者都不一定記得全部的細節了
→ TCPai: ，其他的更不用說
推 orze04: 你傳狀態只用數字，不寫註解就是在浪費之後接手的人的時
→ orze04: 間
推 uohZemllac: /*我不知道這幹嘛的 但不要改這個變數 */
→ orze04: 有一種直白叫做自己覺得直白
推 starsheep013: 寫死還不註解，超欠幹==
→ Jameshunter: 後幾乎都是分成一堆一堆的模組 這時候還沒註解就GG
→ kcball: 註解是寫給自己看的
→ kirimaru73: 更恐怖的是寫這100層的人都有可能寫出
→ kirimaru73: 「code實際上會產生但寫的人渾然不知的嚴重後果」
→ qwer338859: 有時候加註解的code才是更坑人的 有些人改完功能沒改
→ qwer338859: 註解...
→ z635066: 你到火車站沒時刻表也能上車阿，沒毛病
→ S04870487: 寫爛又不寫註解的人不該寫CODE，只是來拖累其他人
推 s12108478: 寫得再好也怕疊床架屋阿，該駐就要駐
推 babyIam: 程式就是文件，一個人寫文件都用自己發明的詞彙然後都不
→ babyIam: 解釋，你感受看看
→ inte629l: 寫死或是magic number的碰都不敢碰
→ arrenwu: 註解寫爛 那PR的 Reviewer要叫她改啊 不能看不懂還送
推 Peurintesa: 不過圖中的例子的確是最欠幹的 寫死不註解是最可怕的
推 sepzako: 你有沒有要給別人看？ 沒有 那你記得就好  有 那你不想被
→ sepzako: 問到煩還是被靠杯就乖乖加  將心比心一下
→ spfy: 西恰到底是有多少工程師
→ terry955048: 以都給WINDOWS用的來說好了，難道不是詞彙都規定好的
推 jeff666: 先求有註解，再求讓所有人都可以看懂
推 ohmylove347: 會被修改的東西才有寫註解的必要，使用說明那種該寫
→ ohmylove347: 的是文檔
→ terry955048: 辭典之類的東西下去邊寫作文的嗎?
→ bluejark: 後面：前面的不寫註解我接手很難懂
推 AkikaCat: //以前我跟上帝知道這是啥，現在只剩上帝知道了
→ bluejark: 前面的：老子都失業了你不懂關我屁事
推 chuegou: 當限制來自沒有道理的業務邏輯時 不註解別人根本不知道
推 leviathen: 寫的好其實不用註解也很好讀，大部分情況都是寫太爛太
→ leviathen: 複雜才加一堆註解
→ kirimaru73: 如果你明確知道問題只出在第89層，你可以把寫的人叫
→ kirimaru73: 出來電，但實際的狀況是裡面可能有10個你根本不知道
→ kirimaru73: 位置和觸發方法的問題，而且這整坨東西已經在市場中
→ kirimaru73: 客戶手上天天執行，這時你能相信的只有某島國零食了
→ terry955048: 你自己創詞彙的話windows怎麼有辦法認識?
推 ziggs8308: //這段沒用，但是刪了會error，別刪
推 paul26277: 檔 不能沒有 註解
→ arrenwu: 任何的code 都有可能被修改啊
推 aegius1r: 你看得懂別人作文全部的邏輯嗎w
推 kirimaru73: 你是在windows給你的架構之上做事沒錯，但你自己要做
→ kirimaru73: 的事情可能就有100層邏輯了
推 qd6590: 沒註解還可以硬讀 只是很吃力 沒欄位文件的超級靠腰...
推 dongdong0405: 前提是Code本身寫得有可讀性
→ dongdong0405: 但偏偏一堆ninja code卻又不註解的
推 b4824583: 只要這隻程式你過好幾個月回來還是看得懂，或是別人看
→ b4824583: 得懂，以這個概念來說，你要不要寫註解就沒那麼重要，
→ b4824583: 重要的是未來看得懂
→ qd6590: 另外可以讓你臭幹誰寫的爛CODE 阿 原來是我 抱歉
推 lovegensokyo: 寫code不註解，連未來的自己都會詛咒你
→ linzero: 但未來的事，沒人能打包票
→ qd6590: 我個人只會寫 為什麼要做這件事的註解跟誰叫我改的
推 shinelusnake: 我覺得寫註解像是英文作文寫的太差怕人看不懂所以
→ shinelusnake: 還要附中文翻譯一樣，如果你英文寫得清楚根本不用
→ shinelusnake: 中文翻譯
→ shinelusnake: 維護註解等同於維護兩倍的程式碼，最多就寫程式結
→ shinelusnake: 構或思路就好
推 orze04: 會被修改的東西才有寫註解的必要？？？除非你敢確定debug
→ orze04: 時不會碰到
→ kirimaru73: 另外一個問題，如果windows現有的架構有會導致不確定
→ kirimaru73: 性結果的bug，請問你是要用你全部的上班時間打電話去
→ kirimaru73: 微軟靠夭，還是夾緊你的括約肌，把眼淚吞下去，想盡
→ kirimaru73: 辦法頂著這個bug還能把你的工作做好?
→ s2500205: 涉及到計算方面的，再怎麼好讀回頭再看也記不得為啥要
→ s2500205: 這樣算
推 ilohoo: 加註解可以讓原作者和其他人看得懂
→ S04870487: 我認識的不寫註解又寫得很難懂的，大多他的CODE問題多
推 The4sakenOne: 可讀性夠高可以不加
推 lucky0417: 只能說 有多少屎山代碼證明了那些覺得自己寫很好的都…
→ lucky0417: …
推 tim5201314: 註解沒更新的才哭 跟code對不上
推 JUSTMYSUN: ///記得刪掉
推 aegius1r: code夠好不用寫註解 跟很有錢買東西不用看價錢一樣
推 Shawn5689: 註解是用來記錄違反常理的事情 有些事情不是自己可以決
→ terry955048: Kiri大的解釋利好血汗但又真好懂XDD原來是這個意思
→ Shawn5689: 定的
推 qd6590: //這邊先這樣 之後再改    去你媽的 之後是什麼時候
推 qwe78971: 看狀況 完全不加 要交接很難 通常命名會很清楚 怕的是
→ qwe78971: abc void a(x) 這種天才
推 Peurintesa: 實務上真會出現a,b,c這種變數嗎?這不只寫的人要被幹吧
推 cutearia: 那種亂命名來搞的 公司哪會讓你merge進去
推 orze04: 有一種好是自己覺得好
→ S04870487: 我做過6~7間公司 能讓我覺得寫得好不用註解的人沒幾個
推 oyaji5566: 我的話 閒的時候會把需求寫進去 忙的時候只註明magic
→ oyaji5566:  number的由來跟用途
→ cutearia: review時先被主管噴一頓
推 kirimaru73: 超內層為了加速運算而寫出的小函式可以允許
→ su4vu6: 就懶阿 反正也沒人會看
推 howtotell: 這個真的要寫
推 aegius1r: 你要先確定公司有review欸(
→ linzero: 不過ijk這種有的是用在很多層的迴圈裡吧
→ orze04: 你以為所有公司review都會看那麼仔細嗎？
→ NingK: 4，不寫連你自己都看不懂自己寫的
推 s2500205: 很多公司不是能執行就過了嗎，誰會逐步執行一行一行看
→ kirimaru73: 中大型公司review至少會有一定的程度，那個真的有用
推 chunfo: 未來的你會最恨你
→ kirimaru73: 小型的就....你覺得鳥的程式會給熊review嗎 當然沒有
→ slainshadow: 未來的你：我當初寫這段是要幹嘛的？
→ cutearia: 當然不會一行一行看啊 但這種一眼瞄過去就很明顯
→ kirimaru73: code review本來就是像濾網一樣的東西
→ kirimaru73: 厲害的人他的濾網就是有價值
推 corum68972: https://youtu.be/wqeGPX7TRv0
→ Puye: 不懶就注一下 別人在看才會比較輕鬆
→ s2500205: 當未來要debug的時候確實是那時的你最恨當初的你
→ kirimaru73: 大家都把濾網捅破還裝沒事 那就大家一起死
推 qd6590: 我覺得註解最需要的地方就是接別人爛CODE又沒時間重構的時
→ qd6590: 候 已經花很大力氣好不容易看懂了 一定要寫下來到底在幹麻
推 orze04: 有的公司連git版控都沒有，這版改了什麼還要自己diff
推 gate210: 本體盡量寫好 註解只在必要的時候寫就好 不然改code連註
→ gate210: 解也要一起改也是很麻煩
推 andy0121: Clean code
推 engelba: 維運到20年前的糞code 就知道有多開心了 有註解至少知道
→ engelba: 需求是什麼
推 yn96503: 別再說寫的好不用加註解了，每個人都嘛自我感覺良好認為
→ yn96503: 自己很會寫很好讀，我帶的案子看到一個註解都沒有誰管你
→ yn96503: 寫什麼一律抓來噴
推 kirimaru73: 大公司對程式的要求不是像什麼書本上的美妙範例
→ kirimaru73: 而是一些類似軍事管理的要求要所有人遵守
→ kirimaru73: 除非你就是想跟所有人對著幹 否則就乖乖遵守就好
→ kirimaru73: 對程式無規則要求的職場不會比較好玩
推 sakeru: 不加註解是要人家通靈喔
推 ayuhb: 跟配線不標示線號一樣嗎
推 lininu: 淦你不寫註解數年後回來修，你看得懂或跟別人解釋當時為什
→ lininu: 麼這樣寫，你就可以不寫註解
→ oyaji5566: // 客戶堅持要這樣做
推 orze04: 學校時，課程作業會把clean code當評分標準嗎？還是答案
→ orze04: 對就好？
推 s81048112: 真的 不加註解真的讓人不爽
推 arrenwu: 學校的程式作業 註解都馬是交給助教看的 出問題重寫
→ kirimaru73: 學校一般不太會管 因為這個給公司電就好
→ arrenwu: 可能比debug快多了 反正上完課之後就是廢code不用維護
→ louis0724: 可以啊 你就永遠不要讓別人維護 跟自己永遠看得懂自己
→ louis0724: 在幹嘛XD
→ louis0724: 我自己上個月寫的程式我可能就看不懂這什麼狗幹邏輯了
→ peefly: text-align: left;  /* 客戶說要偏右 */
→ peefly: 然後你就不知道是客戶又改了還是註解漏改
→ kirimaru73: 真的漂亮到一看就讚嘆的code是有可能存在的
→ kirimaru73: 可是你的無註解code就是被噴了啊 那就是不夠漂亮嘛
推 Wayne0926: 不加 幾個月後來看自己也看不懂了
推 deflife: // just magic
→ linzero: 學校的程式作業不會多大且目的明確，不寫註解其實也還好
推 AkikaCat: 當下的你：這段帥爆了，不用註解也知道在幹嘛
推 dk2486248: 會動就好
→ AkikaCat: 下個月的你：誰把上個月的我抓來讓我扁一頓
推 arrenwu: 所以才需要reviewer啊
推 kingroy: 變數名，函數名，class名都取的很標準的，可以不寫或寫很
→ kingroy: 少，但一定規模以上不寫幾乎不可能
→ kirimaru73: 可能會有這樣的狀況
→ kirimaru73: text-align: left;  // 不加的話頁面垂直對齊會失效
→ kirimaru73: 哪個人敢刪掉這條註解就給我刪看看
推 zizc06719: 不加註解，過一段時間連你自己都看不懂好嗎
推 snac: 基本上好的程式看naming要能看出大部分，複雜的才要特別寫註
→ snac: 解
推 h0103661: 註解還好，程式夠乾淨、名子別蝦雞巴取都還看的出來，一
→ h0103661: 個泛型當戰神用才討人厭= =
→ kirimaru73: code review真的不是騙小孩的笑話，它真的有用
推 orze04: 學校作業一堆連排版都壞七八糟
推 s971425: 不加註解只有神或廢物，廢物占99%
→ kingroy: 有寫接手交接所需的時間比較少，但一般取名取很差的，註
→ kingroy: 解也寫的很差
→ linzero: 不過寫嵌入式系統資源有限之類的，有時變數不能用太多，
推 arrenwu: 以前code review我還覺得"幹 怎麼一直要我寫一堆註解"
推 RuinAngel: 曾經覺得隨手寫個小程式輔助用的就不用加註解了
→ kirimaru73: 新人剛進公司的code被評價為矮噁是很正常的
→ kirimaru73: 不用灰心，遵守規則就好
→ arrenwu: 現在回想只覺得"挖糙 我以前註解寫那麼少喔"
推 Kururu8079: 不怕沒有註解，就怕亂註解誤導後續接管的人，整組壞光
→ Kururu8079: 光
→ linzero: 可能會一個變數多種用途吧
→ RuinAngel: 過了半年想要加點功能跟改 bug 的時候只想砍死我自己
→ uoyevoltnaw: code很好不用寫的通常就是……
→ kingroy: 行業標準的註解就去看自動生成文件那些怎寫就知道了
推 miyazakisun2: 肉便器代碼 用過一次就不理的話可以
推 newasus: // 敝公司碼農領的薪水用行數計算
推 felix1031: 寫得爛還不承認的最爛
推 iwtwin086051: 漂亮的程式碼不等於容易看懂的程式碼
→ iwtwin086051: 反而容易讀懂的程式碼 常常是過於冗長
→ iwtwin086051: 打個比方就是
→ iwtwin086051: 好的程式碼就是一個漂亮的公式
→ iwtwin086051: 簡潔又高效
→ iwtwin086051: 沒看過證明 你是要怎麼了解公式怎麼來的？
→ iwtwin086051: 你不了解 怎麼客製優化和調整參數
推 devil115789: 除非一看就知道在幹嘛，不然還是寫一下吧…半年後自
→ devil115789: 己都看不懂了
推 pikachu8177: 不加註解我連自己1個月前寫的code都看不懂..
推 aa1477888: 你不寫可以 但你不要給別人review
→ miyazakisun2: 不寫註解= 小組組員問你問題你已讀不回
推 arrenwu: 沒啦  已讀不回應該是 github上面人家留comment你直接
→ arrenwu: 啥都不做就按下 resolved
→ arrenwu: 這種很容易起糾紛的
推 kingroy: 一個月後可能換個project就想不起之前在趕嘛
推 black51002: 不註解就是後面自己或者接手的人完全看不懂
噓 Anchorage: 不加comment真的有夠夭壽，後人還要通靈通個老半天
→ usoko: 看你寫的code好不好懂 但不管再怎麼會寫code的人
推 kirimaru73: 這跟在萬神殿問到本子名的瞬間就刪文一樣惡劣嗎
→ usoko: 都一定會碰到必須把code寫得很醜 再加一堆註釋的情況
→ usoko: 你不加註釋 那段code過一段時間就會變成廢物跟技術債
→ arrenwu: 跟好不好懂沒有關係啊 你開一個新的class 在我讀程式碼前
→ arrenwu: 就該有一段文章在描述這class是幹嘛的
→ arrenwu: 而不是我要讀了程式碼之後才知道你在幹嘛
推 baliuzeger: 有型別的語言問題小一點
→ arrenwu: 現在有 Copilot，寫作文比以前方便多了
→ baliuzeger: 沒型別的語言該註解沒註解的話超難通靈
→ kirimaru73: 中心思想就是：好好做個人，讓別人能看懂你的code
→ kirimaru73: 你要每行都註解還是把87%註解集中在關鍵處就看你
→ kirimaru73: 反正別人能看懂就沒事，看不懂就一起浪費時間
→ usoko: 那看是什麼語言 有必要的話我就在file name跟class name
→ usoko: 把這個class是做什麼的直接寫完了
→ arrenwu: 這不太可能吧？ 你class name 可以寫500個字喔？
→ arrenwu: 講500個字誇張了 但你總不可能寫50~100字吧
→ usoko: 你一個class做的事情要用500字來寫不就代表class太大了...
→ kirimaru73: 那個比較像document，但順手寫成註解也可以
→ arrenwu: document這個東西我想都不敢想了
→ usoko: 比較大的class確實很難命名 那種情況的確要寫說明
→ oyaji5566: // 因客戶說他老花眼一直輸錯認證碼因此需要把輸入的
→ oyaji5566: 值1=I=L，2=Z，5=S
→ kirimaru73: 看是哪種class啊，如果class是一隻狗
推 XFarter: clean code 的許多準則很好，但不是絕對準則，許多跟算法
→ arrenwu: 我上面說了 嘴巴上說會寫document的 不是精英就是騙子
→ XFarter: 有關係的函數不寫註解不寫 argument 只憑個名字就期待大
→ XFarter: 家知道結構在幹嘛就真的會讓人惱火==
→ XFarter: 我個人認為越底層、越接近硬體行為的 work 越不能不加注
→ XFarter: 解
推 freedom0116: 會加但不會有很多 通常是特殊情況會解釋一下 一般來
→ freedom0116: 說你的程式碼本來就該寫得讓人看得懂 不然review 怎
→ freedom0116: 麼可能會過
→ kirimaru73: 那你覺的這是一隻狗算不算講完他能作的事情
→ usoko: 但很複雜的多個class我就直接寫module REAME了
→ usoko: *README
→ arrenwu: 會寫document的，有啥理由PR的時候不加註解？
→ JamesChen: 除非那個 code 沒有其他人要看，而且你自己的記憶力超
→ JamesChen: 好，不然即使自己用的 code 都該為了未來的自己寫註解
推 ayumi001: 當你看過註解和程式之間的走向完全不同的時候你就會有另
推 adonisXD: 自己都看不懂還不加註 不就找自己麻煩
→ arrenwu: @kirimaru73 不算 你還要告訴我為什麼這裡有吃狗 要幹嘛
→ ayumi001: 一種看法了
→ usoko: 自己寫的code大概半年不碰就會忘光了 一定要寫
→ arrenwu: PR還在審視的時候，你還能卡著逼對方寫註解
→ arrenwu: Code 送進去之後 對方不鳥你你根本沒轍
→ Arashi0731: 我也沒在寫註解了，乾淨架構下去，然後變數跟方法命名
→ Arashi0731: 寫好，基本上看得很清楚
→ kirimaru73: 那些我就會直接寫在class Dog的上面了 應該和你期望
→ kirimaru73: 的一樣
→ usoko: clean architecture有幫助 但不是萬解
→ arrenwu: 某種意義上 寫註解就跟買保險很像，這個東西就是盡可能
→ arrenwu: 避免未來某一天「幹!!!這到底是三小」的機會
→ arrenwu: 但也可能最終發現註解寫得不好所以沒有用
→ arrenwu: 但絕對比不寫好得多
→ usoko: 我自己的判斷方式 只要nested到一定程度(3層之類) 就一定
推 orze04: 問題不是這段在做什麼，而是為什麼要這麼作
→ usoko: 要寫 不然不熟的人絕對浪費時間看
→ Arashi0731: 重點把是你的架構訂好，依循著架構放檔案，各種依賴跟
→ Arashi0731: 參考都有照著規則比寫一堆狗屎註解重要
→ tommy56665: 這個本來就是分兩派好嗎..
→ orze04: 大型project最後都難免變違章建築
推 Alcazer: 以前教授說他都寫德文 不想給別人看懂
→ usoko: 這年頭lint都會檢查啊 即便如此還是有可能寫得很複雜
推 amsmsk: 不加註解自己也會看不懂吧
推 LeoYuri: 不加註解，我還真的無法一瞬間看出來在幹嘛
推 alaf: 一個月前的自己:自己寫的一定懂 一個月後的我:這段是啥鬼
推 kctrl: 自己的程式加註解都要思考幾分鐘在幹嘛了，更不用說別人的
→ kctrl: 我相信世界上有天才不需要註解，但那個人絕對不是我
推 abd86731: 比不簽聯絡簿還噁心
推 s207072s: 有一派是code好不用註解，但現實通常是隨時間跟經手的人
→ s207072s: 變多gg
推 dnkofe: 看你的程式別人需不需要用，需要的話還是要註解
推 alpho: 雖然取名能解決很多閱讀問題 但註解可以直接省下這些問題
→ alpho: ，特別是遇到取名new或是obj的人
推 orze04: 還有一種是註解裡故意埋炸彈給接手的垃圾
推 edwardtp: 自己寫都不一定知道在幹嘛，一定要加註
推 ilohoo: 寫code的動機是“客戶說”那就註定好不了。乖乖把“客戶希
→ ilohoo: 望能夠1+1=5”寫在註解上
推 milkool: 不加註解死全家
推 b325019: 不寫註解一樣能埋炸彈特例就別說了
推 andy3231: 看過一本講refactor的有提到盡量不要寫註釋，只有特殊
→ andy3231: 情況才要寫
→ s2500205: 一堆亂七八糟的調整都嘛是來自“客戶要求”，別想會多
→ s2500205: 好
推 sunshinecan: //呃...就命名字面上的用途
→ six93250: 除非整個團隊英文能力都很好，不然clean code的意思是
→ six93250: 變數與函式的命名要清楚到能直接看懂程式的意思
→ andy3231: 我同事兩百行code有一百行是註釋不知道在衝三小
推 lucky0417: 這個問題其實很簡單 現在回去翻自己幾年前寫的 測測自
→ lucky0417: 己不看註解的情況下要用多久能全理解
→ sunshinecan: 當然有些特例 像是寫random但實際上有加權時就要註解
推 lylu: 除了註解本來就有很多地方可以記錄資訊啊 你commit msg也是
→ lylu: 要寫清楚 clean code就是追求程式碼本身就是註解 function
→ lylu: 跟class名稱都要有意義
→ six93250: 但大多數人連命名都亂七八糟的
推 FCPo011674: 我是覺得可以讓命名、結構易懂比寫註解重要，不然程式
推 tuwulisu6111: 有時註解反而在騙人 不如專注在把命名做好
→ FCPo011674: 碼改了註解沒改也有機會變炸彈；不過程式複雜或是有什
→ FCPo011674: 麼需要特別說明的地方還是要下註解
→ odanaga: 寫很爛又沒註解 就王八蛋
→ ARTORIA: 看不看得懂是一回事 寫了是幫之後看的人省時間
→ ARTORIA: 就算code寫得好懂 每次重看也是浪費時間
→ wzmildf: 有自信永遠不帶給自己和他人困擾就別加，我連一個月前自
→ wzmildf: 己在excel寫的VBA 都可能看不懂
推 thelittleone: 註解寫了也要記得更新 改code不改註解寫心酸的
推 bdenken: Chatgpt 都會寫好註解
推 togs: 自己寫的都不一定記得了。
推 emptylife3: 我看現在大師的說法是追求程式的可讀性要高，夠高的
→ emptylife3: 話不註解也很清楚
推 ohohohya: 我都有git了還註解啥
推 s56565566123: 真的寫到很簡單根本不用註解
推 highwayshih: 除非你是那種Code可讀性極高 誰來都能馬上理解的神人
推 lylu: 不然就build script最後加doxygen 沒寫直接build fail
推 coronach: 有很多地方可以放解說，不需要都寫在註解
→ highwayshih: 不然寫扣不加註解真的罪該萬死
→ coronach: commit msg跟README還有design doc都可以寫
推 oread168: 然後變數用ABCD1234不命名  爽不爽
推 e2ne0: 命名就知道是在幹嘛了 幹嘛還要註解==
推 Dayton: 對 超級
推 shallreturn: 寧願加註解也不要相信自己看得懂自己的東西
→ shallreturn: 你自己寫的日記都有可能不知道你在寫什麼更何況是代
→ shallreturn: 碼
→ devilkool: 有的流程、特殊邏輯，變數跟方法命名都無法表達的
推 highwayshih: 回頭看自己三個月前寫的東西都有可能看不懂了
推 keichi: 其實不會
推 Beltran: 2025還有人把clean code當聖經 幾年前就戰過了
→ highwayshih: 有機會被別人看到的Code不加註解想害死誰
推 ltytw: 寫代碼不加註解。就算只有自己會看也是一段時間連自己都看
→ ltytw: 不懂
推 hanklee66: 寫得再好也不可能理解起來比註解還好吧，註解都亂寫的
→ hanklee66: 他程式會好好寫嗎...
推 FiveSix911: 超多的好嗎 超討厭
推 plamosuki: 寫註解就是要告知這坨大便是什麼原因產生的啊
推 hsshkisskiss: 真的很賭爛
→ AlphaMC: 看你是當個人日記還是出版書籍來寫啊，只是個人日記過幾
→ AlphaMC: 個月連自己都不知道在寫什麼了
推 Peurintesa: 對耶 註解寫得好的人那原始碼應該不會爛到哪吧
推 Bf109G6: issue解一解 忙了半年之後回頭過來看 就忘記我在幹嘛了
推 yys310: 三個月後自己看都忘記了
推 FCPo011674: 這麼說好了，寫出易懂的程式是一個理想；但現實是不可
→ FCPo011674: 能完全達到的，不管是有特殊邏輯，或是寫的東西並沒有
→ FCPo011674: 那麼好懂。一定或多或少要有註解輔助
→ FCPo011674: 其實註解寫的好不代表原始碼會多花，我遇過一個leader
→ FCPo011674: 註解寫很勤且很多，也要求底下的人照做；但我接手他的
→ FCPo011674: code後改到快吐了
→ FCPo011674: *多好
推 shinchen: 偏底層的程式要搞加速或省資源的時候就管不了可讀性了
→ Void956: 有時候註解說的是一回事，程式碼寫的卻是另一回事，所以
→ Void956: 註解真的比較好嗎？
→ Dlareme: 不用三個月 忙一點同時兩三個案子 下個禮拜就忘了
推 as6633208: 其實，真正優秀的團隊，是真的不用註解，含在design pa
→ as6633208: ttern惹..
→ FCPo011674: 各種惡用巢狀迴圈，即使裡面寫了滿滿的註解，我還是很
→ FCPo011674: 難修；最後我就直接打掉重寫了
→ coronach: 遇過資深工程師意見超多+話超多+文件超長，但是一半左
→ coronach: 右是廢話的
→ as6633208: 無註解是比較理想化，實際有些東西還是要註解會比較清
→ as6633208: 楚
推 chris510127: 你兩個月後回去看自己的程式就差不多忘了
→ ARTORIA: 不可能無註解比較好啊 你有註解你的程式碼我不用全懂
推 coronach: 實際上一定會需要註解，大部分是用在special case or w
→ coronach: orkaround
→ ARTORIA: 要修改部分功能 有註解改起來也快
→ Jimmywin: 連自己都看不懂
→ coronach: 通常真正的問題是，那些特殊性高的code寫完就忘了維護
→ coronach: ，註解也沒用
推 shinchen: 搞底層韌體有時候會需要計較這段code怎麼寫編出來可以少
→ shinchen: 幾個指令或多少RAM 這種不留註解沒人知道你幹嘛這樣做
→ Syalon: 這串吊出一堆寫扣大佬
→ Void956: 我自己寫程式也是偏向少註解，因為用code說話比較好。
推 sustto: 4
推 shadowblade: 我自己是無法理解自己看不懂這件事啦,可能我的思考
→ shadowblade: 迴路是基本很難變動的那種
→ rizman28: 現在有LLM其實也沒差了我覺得
推 andykimo123: 自己寫得看久了當然會看懂，只是你要花多少時間去看
→ andykimo123: 寫註解可以幫助自己回想的快很多
→ ARTORIA: 對阿 懂不懂是一回事 主要是省時
推 leonEEman: 我公司就是喔 主管還自以為code寫很棒
推 ren740719: 說寫Code不用註解的，都是待在同事都是高手，離職率超
推 pumapupa: 有些狀況是寫理由 看得懂code也不一定知道為甚麼這樣寫
推 tmwolf: 超靠北
→ ren740719: 低的公司吧?
推 ccukiller: 大神寫出來的就算加註解一般人也看不懂 邏輯完全跟不上
推 ren740719: 我待過沒Code Review的公司，接手離職人員的專案，我只
→ ren740719: 想寄一箱手榴彈去問候他
推 tmwolf: 本篇講的就是寫死的，寫死又不留註解，後面接力的人大家都
→ tmwolf: 要當通靈王
推 jack529: 如果有workaround 或是 複雜邏輯 沒加就垃圾人
推 pantani: 就像你創出一道菜沒做筆記某天上了菜單  別說要同事復刻
→ pantani:  連自己都不一定記得調味的份量
→ driver0811: TODO 需要增加註解
推 joeii0126: 改code完沒改註解更加糟糕欸嘿
推 hanklee66: 一碼歸一碼，註解沒改是改的人的問題，不是當初寫的那
→ hanklee66: 個
→ RS232: 不加註解然後全部參數都是abc順編
推 RoastCorn: 這是犯罪==
推 drinkmuffin: 命名就是註解了 不要寫一推難維護的註解
推 yesyesyesyes: 如果架構爛又不寫註解的真的很過分，要其他人通靈嗎
→ k960608: 跟古文還有甲骨文一樣 資訊超少 自己掰
推 mmppeegg: 超杜蘭，尤其是人過世了，接他的code每天在解謎
推 joeii0126: 被糾正過只要方法、物件、變數名稱有取好，其實不用寫
→ joeii0126: 太多註解，要不然有人接手改code還要對照改註解比較麻
→ joeii0126: 煩。
推 siro0207: 不過有時候註解也不好寫 以前寫了一些數學解題演算法 但
→ siro0207: 我註解只有寫變數使用規則 結果我計算出演算法的紙搞丟
→ willy986231: 沒寫註解 一個禮拜後就都不知道在寫什麼了
→ siro0207: 了 導致我光看code也看不出我當初是怎麼算出這套公式的
推 h60414: 4 大概就只顧自己爽的傢伙 交接他的東西跟通靈一樣
→ frankfipgd: 不加註解…連自己都坑好嗎…
推 a7173661736: 不加註解 半年後連我自己都看不懂
推 vul3kuo: 註解不維護比不寫註解還要討厭
推 iamsuhyeon: 丟給chatgpt就好啦
推 leophior: 不寫註解 下個月的自己就看不懂了
推 yu7777: 心理變態484
推 devilhades: 泰德創造了三個工作機會 謝謝泰德
→ laechan: 註解其實是寫給自己看的，不寫的人遲早業力引爆，痛過才
→ laechan: 會知道痛
推 kevin0316: 不加註解的都是低端pg
推 vios10009: 註解寫得好也是能力之一
推 Richun: 寫太多註解會出現一種更靠北的情況，註解過期了沒修正。
推 defreestijl: 段落跟region會加 方法的類本身直接名字寫清楚就夠了
推 rainight1218: 通常在變數跟函數命名時命名的精準，就不太需要註
→ rainight1218: 解了，因為可以推敲
→ jgoodman: 還好吧 程式碼本身可讀性比較重要 註解是特殊情況才加
推 kojojo: 不寫註解 沒上班時間 就是call 你解異常
噓 gamesame7711: 想到就非常不爽
→ kentyeh: 看單元測試就知道設計意圖
推 bellea70068: 當然是第一版加註解 第87版繼續用第一版的註解
推 XFarter: 強制註解一定要下在函數的名字前面或 content 的第一行、
→ XFarter: 解釋當前的行為邏輯就不會有忘記修的問題了吧
→ XFarter: 但這就要靠個人甚至團隊的約束
→ AmibaGelos: 設計決策magic#等code無法涵蓋的資訊才需要註解ㄅ
→ spfy: 註解寫太多沒有跟真實扣一起改我坑過自己 幹 之後開始反省
推 Ayukawayen: 程式是照程式碼跑，不是照註解跑。
→ Ayukawayen: 註解寫錯寫爛了要抓出來，比程式碼寫錯寫爛要抓難多了
推 mbla: 比較常遇到code囤積症，舊的code想刪掉但又不想刪乾淨，覺得
→ mbla: 以後有可能改回去，所以直接把舊的code註解
推 denny0411: ninja code, 變數名：a, b, c, d, e...
推 felaray: 還好我都用中文命名
推 mike2685a: 自己回頭看都有可能看不懂了
→ ThreeNG: https://i.imgur.com/uqppu1M.png
推 ZhengMark: 亂註解比較搞吧
推 ikachann: 我要底下PG寫簡單功能註解，主要是確定他真的懂...有些
→ ikachann: 會莫名亂抄東西貼上 根本不了解裡面在做什麼
推 bigbeat: 變數至少要說明一下啊
→ aegius1r: 然而這年頭你會遇到PG丟GPT註解..
推 kingo2327: 笑死這串怨氣是多重
推 ejnfu: 理論上應該是要能不寫註解就看懂得
推 Alex548291: 某些特定操作一定要寫吧
→ Alex548291: 不寫就算自己寫的過一陣子回來看也不知道在幹嘛
推 wulouise: revirwer叫你加就加，別人看不懂就是你的問題，除非你下
→ wulouise: 周閃人
推 smartsnake: 看到大家的回應忽然覺得自己記憶力沒那麼差了
推 kingroy: 有版控就別屯了
→ kingroy: 但註解寫錯不會出事，Code寫錯會，註解錯了了不起改一下
→ kingroy: ，也不用重跑測試
推 Ayukawayen: 不太確定你想表達的意思。寫錯會出事是很好的特性..或
→ Ayukawayen: 許不是真的很好，但寫錯不會出事肯定是很爛的特性。
推 terry6503: 我通常都寫：別動，我也不知道為什麼可以運作
推 ayubabbit: 丟給AI
推 GAOTT: 要寫 但必須只有自己能幹 不然老闆隨時辭退你
推 tomhawkreal: 如果你看到匪夷所思的註解 必須知道這是日常 XD
推 elic2577: 變數參數不好好命名，命名abc的才是在搞
推 BANDITCS: 會，超幹，寫註解反而搞的更難懂就更麻煩了
→ wanzi0601: 註解對開發沒屁用，是因為開發的人不用維護....做維護
→ wanzi0601: 的人最煩不寫註解的混蛋
推 chaahk2012: 不加的就保佑不會雷到自己
→ chaahk2012: 除非心機很重 注釋寫另一份
推 shoederl: 我大學升書研究所左右看清自己只是凡人後明白一個道理，
→ shoederl: 就是寫任何報告或程式，一定要遵循「三個月後自己回來看
→ shoederl: 能看懂」的原則，不然寫出來的東西都是只能用一次的廢物
→ WWIII: 最好的扣 是不用註解
→ ailio: 完美的程式或是小流程，不太維護不太修改的沒註解沒差，常
→ ailio: 維護的沒註解最後一人加一段就沒人認得了
推 ppc: 1. 好的code本身要能夠自我解釋 2. 註解是用來寫你這段code想
→ ppc: 要達成的事情，而不是這段code實現的細節
→ PerFumeLove: 還好我覺得
推 upeo: 註解還能幹譙人 好註解不寫嗎？
推 yueayase: 做學生倒是懶得加
→ yueayase: 理由：1. 多寫多錯 2.分數不會比較高 3. 連自己都看不懂
推 nomosa: 不加我有可能幾個月後就不知道自己在寫三小
推 rickey1270: 屎山代碼愈來愈多的癥結
推 jackjoke2007: 歷史本文
推 annboy: 註解某種意義上比程式本身還重要
推 leviathen: 最需要註解的是莫名其妙的feature ，這個不寫一定早晚
→ leviathen: 出事
推 Sniqow: 看過註解寫一段佛經的
推 k798976869: 寫註解改code不更新的比較北爛 誤導
推 louner: 40樓那個 不是事先知道那個演算法的人應該都看不懂吧 就
→ louner: 算有註解也一樣
→ louner: 讓人看懂就好 求學時老師說過程式碼不是寫給電腦 是寫給
→ louner: 人看的 這句是真的
推 passerbycat: 丟chatGPT上註解就好了啊
推 hh123yaya: 命名弄好可以省一些 不過同事看不懂英文是另一回事了
推 ppn: 註解重要 但命名更重要 甚至可以犧牲一定效能來遷就可讀性
→ ppn: 不然debug時候你會痛恨一星期前的自己
→ rogerlarger: 程式碼的function要從巨觀到微觀，舉例來說你程式做
→ rogerlarger: 四件事，你main底下最好就只call四個function這樣讀
→ rogerlarger: 起來就很清楚，然後變數跟function命名很重要
→ rogerlarger: 註解的問題在於它不改也不會死，所以有時候底下code
→ rogerlarger: 都改了n次了註解還是最舊版
推 daiYuTsung: 我只有在看不懂自己寫什麼後來又看懂之後才會考慮...
→ daiYuTsung: 可是會優先考慮重構讓程式本身能被看懂...
→ daiYuTsung: 無法重構時才加註解...