餓死抬頭
https://i.imgur.com/3QcIsVN.jpeg
本魯不是資工系的啦
所以不知道寫程式不加註解會有多嚴重
想請問相關從業的鄉民
實務上遇到這種情況真的很賭爛嗎
乾五西恰
作者:
llabc1000 (野生的攻城ç…)
2024-12-25 18:21:00不加註解的一定是超級有能的傢伙
作者:
tk13os (tk13os)
2024-12-25 18:21:00前提是code寫的讓人看不懂,還不加註解
作者:
linzero (【林】)
2024-12-25 18:21:00接手的很麻煩,要多花時間理解
作者:
tk13os (tk13os)
2024-12-25 18:22:00就算是自己寫的也可能幾個月後看不懂
作者:
HJC6666 (帕修)
2024-12-25 18:22:00不一定 要看是不是寫垃圾
作者:
pot1234 (鍋子)
2024-12-25 18:22:00比註解寫的像日記隨筆的好一點
作者:
linzero (【林】)
2024-12-25 18:23:00函式參數名稱取的有其意義也算是種註解
作者: sniperex168 2024-12-25 18:23:00
連自己都不一定看的懂了
作者:
yuizero (14)
2024-12-25 18:23:00我直接給你一個題目 a + b = 5然後告訴你 a 和b都是一個正整數 而且在設計者心中是一個唯一解。就這樣
作者:
grtfor (哦啦啦)
2024-12-25 18:23:00不是,是註解內容與事實不符,成年累月不刪的錯誤訊息誤導
作者:
OSDim (I'm So Sorry)
2024-12-25 18:23:00這垃圾是誰寫的,喔 是我==
寫得極好可以不加註解 這是真的不過你們這些庸才不要隨便就自認為寫得很好嘛
看可讀性 像變數都命名無意義a,b,c的不加註解就很糟
作者: AMTS 2024-12-25 18:24:00
寫得好其實不需要太多註解把說明文件寫好還比較重要
作者:
yuizero (14)
2024-12-25 18:24:00好。請問。當你急用。必須知道a b是什麼時。你會不會很
作者: zore14563 2024-12-25 18:24:00
會不寫註解,八成是是能力很強的g8人= =
作者:
nahsnib (æ‚Ÿ)
2024-12-25 18:24:00顧不顧人怨先不論,一個月後你就會恨自己了
作者:
moebear (萌熊)
2024-12-25 18:25:00註解不改版的才是==
作者:
arrenwu (鍵盤的戰鬼)
2024-12-25 18:25:00現在PR如果是我當reviewer 除非是連白癡都一眼能看出來
作者:
hoe1101 (摸摸)
2024-12-25 18:26:00不會
認真說的話,在團隊合作時,寫的code讓別人能看懂是你的責任,但你不一定要用註解的方式
作者:
arrenwu (鍵盤的戰鬼)
2024-12-25 18:26:00現在有了LLM之後 程式碼的註解用途比以前更多了
會分不清abc幹嘛已經不是註解問題了,而是他媽不要用abc
作者: su4vu6 2024-12-25 18:26:00
自己都會忘記的東西 要給別人猜 試著理解你當時在想啥
作者:
orze04 (orz)
2024-12-25 18:26:00寫的好的話還不算太嚴重
作者:
Porops (豬排)
2024-12-25 18:27:00確實是寫得好就不用註解,但如果是長期營運的專案,很難全部都是好code
作者:
arrenwu (鍵盤的戰鬼)
2024-12-25 18:27:00很多時候註解不是只是寫 還要人看得懂
作者: lucky0417 (L.W) 2024-12-25 18:27:00
現在看你可能覺得自己寫得很好 但十年後你再看可能至少要花半天來重讀 回想還不夠惹人厭哦
作者:
arrenwu (鍵盤的戰鬼)
2024-12-25 18:28:00確實是寫得好就不用註解 <--- 這句話本身就不可證偽幹話
作者: su4vu6 2024-12-25 18:28:00
註解寫得不好 確實會讓你解讀錯 也是個問題
作者: ccococo 2024-12-25 18:28:00
看情況,就算你真的不想寫也要把變數名稱設定好
作者:
orze04 (orz)
2024-12-25 18:28:00最爛的是code改了,註解還沒改,草你媽
作者:
BF109Pilot (å¾·è»çŽ‹ç‰Œé£›è¡Œå“¡)
2024-12-25 18:28:00我有在註解裡連載過偵探小說
print("hello") # 印出 hello
作者:
arrenwu (鍵盤的戰鬼)
2024-12-25 18:29:00PR送出來的時候 幾乎是唯一你有機會要求撰寫者解釋code
作者:
orze04 (orz)
2024-12-25 18:29:00爛code+錯的註解比單純沒註解更垃圾
作者: lucky0417 (L.W) 2024-12-25 18:29:00
改了程式註解沒改更痛苦是真的 一個誤導可能一天就過去
作者: ghgn 2024-12-25 18:29:00
不加註解讓其他人看不懂 這樣公司也不敢炒你
clean code 第四章就是在叫你各位別寫註解了
作者:
wifi (請輸入密碼)
2024-12-25 18:30:00大概跟聯絡簿不簽名一樣
作者:
arrenwu (鍵盤的戰鬼)
2024-12-25 18:30:00"這之後會寫個詳盡的document"=謊言
你如果變數名稱取什麼a b c i j x 三小的 最好就給我寫註解
作者:
MelShina (月落烏啼霜奶仙)
2024-12-25 18:30:00你之後自己也會看不懂
作者:
morichi (我把你們當人看)
2024-12-25 18:31:00commit log有寫好就好
作者: RageDoors (Desires) 2024-12-25 18:31:00
不只是寫code的會需要註解啊,有些管線配得超複雜的又不加個標註,真的下個月就忘記是幹嘛的了
尤其是一堆magic number 又不寫註解為什麼這邊要帶入100 那邊要帶入3000 最後就是一直在通靈程式碼
作者:
s2500205 (KingWon)
2024-12-25 18:31:00不寫註解一陣子後,連作者都不知道那段程式是在幹嘛的
要有改版紀錄,就算別人不看code,也要知道改了啥
作者:
arrenwu (鍵盤的戰鬼)
2024-12-25 18:31:00AMTS: 把說明文件寫好還比較重要 <--- 註解都寫不好的,
作者:
hoe1101 (摸摸)
2024-12-25 18:31:00要加寫註解,那簽薪水合約也要該加錢
what the fuck那個案例,經典之處在於那是一個超級棒的變數搜尋起始值,但又不是數學上最佳的 (有一點偏差,但也夠好用了)然後寫的人沒說他是怎麼找到這個值的 接手的也問不到
註解OK,但我覺得code以外的東西像是文件log啥的有寫清楚我覺得比較重要
作者: trtrtradam (Adam) 2024-12-25 18:32:00
至少節省人家看懂你在寫三小的時間啊
作者:
akway (生活就是要快樂)
2024-12-25 18:32:00商業機密
作者:
hoe1101 (摸摸)
2024-12-25 18:32:00如果是給自己看懂的註解那其實就不是註解,是自我提醒而已
作者:
arrenwu (鍵盤的戰鬼)
2024-12-25 18:32:00寫說明文件這種事情,只有 騙子 和 菁英 在講
作者:
langeo (langeo)
2024-12-25 18:32:00不寫也會害到自己吧 寫了幾千行後自己也會忘記
最好的code是能直接看懂 但一般人就給我乖乖寫註解
陳年code最快樂的是註解一堆都跟code合不起來
作者:
arrenwu (鍵盤的戰鬼)
2024-12-25 18:33:00PR Approver還有立場要求對方寫更多註解;程式碼送進去
作者: Ceferino (麥茶多多) 2024-12-25 18:33:00
現在應該沒什麼差了,直接丟AI
作者:
arrenwu (鍵盤的戰鬼)
2024-12-25 18:34:00Repo之後 她不爽寫文件或註解你絕對沒輒
可是快速反方根算法是真的就只能那樣寫啊 而且那東西就算寫了註解也未必一般水準的工程師就看得懂XD
作者:
idow (Isamu)
2024-12-25 18:34:00他這邊不是講寫死代碼嗎 想講hard code那種的吧
作者: crazyanight (crazyanight) 2024-12-25 18:34:00
覺得可以完全不加的真的有在寫嗎 久了你連自己寫的都看不懂
作者:
Giornno (喬魯諾.喬三槐)
2024-12-25 18:34:00公司祖傳屎山代碼不加註解,敬請見證
作者: lucky0417 (L.W) 2024-12-25 18:34:00
能直接看懂的code本身就不是什麼大東西,上萬行的你看懂要多久
變數寫的很直白就沒差 最哭的是全用a1 a2這種的
作者:
linzero (【林】)
2024-12-25 18:35:00what the fuck那個是較低運算量下求得足夠有效的近似值吧
作者: letmesee3085 (煒哥) 2024-12-25 18:35:00
現在可以叫chat gpt幫你加
作者:
arrenwu (鍵盤的戰鬼)
2024-12-25 18:36:00現在有不少AI工具是可以讀了你的repo之後扮演像小幫手的身分回答你很多廣泛問題。這種有沒有註解就會差超級多
作者:
elia0325 (ptt萬年潛水員)
2024-12-25 18:37:00到時連自己都看不懂就好笑了
作者:
antinua (arbool)
2024-12-25 18:37:00足以放進柯南世界的殺人動機
作者:
arrenwu (鍵盤的戰鬼)
2024-12-25 18:37:00沒有註解的code,AI就只能給些罐頭回答你一個 enum class 註解只寫一行或不寫當然無妨啦
我看過註解英文文法爛到看不懂的 也看過非ASCII註解然後亂碼的 歡樂無限
作者:
fireleo (火焰騎士)
2024-12-25 18:38:00現在AI可以幫你生註解
作者:
Dnight (暗夜)
2024-12-25 18:38:00有時候有問題的不是邏輯看不懂,是為什麼要有這段邏輯
我在弄公司老舊程式的CODE 一堆糞CODE不註解
作者:
hakosaki (hakosaki)
2024-12-25 18:38:00有兩派 一派是命名的好的不用寫 另一派是最好給我寫爛,我覺得加減都要寫,有些寫死在程式裡面的 還有歷史故事 最好都留著,免得到時候要考古
作者:
Pocer (就4論4)
2024-12-25 18:39:00自己寫的不加註解你離開半年再碰都不知道自己在幹啥
現實公司就沒有真的在提倡把code寫好寫到不用註解的你要用這個藉口不寫註解,到時候在公司天花板飛來飛去就不要該該叫
這個看能力分階段耶 寫的好的確不用太多註解也能看懂
作者:
linzero (【林】)
2024-12-25 18:40:00AI現在問題是,你不太懂的,AI也不懂時會瞎掰唬的你以為他講的是正確的吧
你們別再瞎吹AI惹 新進來的搞出一大堆炸彈 被炸死還
作者:
RINPE (RIN)
2024-12-25 18:40:00不會 能力差的才寫
作者: lucky0417 (L.W) 2024-12-25 18:41:00
上面那個邏輯可能跟一些老舊硬體有關 這種又更痛苦了你不測根本不會知道
作者: PatlaborGao2 2024-12-25 18:41:00
自己寫的作文 會自己加上注釋嗎?
你有自信一年後還看得懂的別人基本上也有機會看懂,這樣不寫當然沒關係
作者:
BC0710 (BC)
2024-12-25 18:42:00不註解變數名又亂取的應該要被抓去關
所以寫CODE並不是同一類功能9成一樣套公式的東西嗎??
作者:
linzero (【林】)
2024-12-25 18:42:00有的BUG是兼容性問題,這種可能就沒有啥原因邏輯,因為
作者:
arrenwu (鍵盤的戰鬼)
2024-12-25 18:43:00code 不是作文 註解才是作文
作者:
linzero (【林】)
2024-12-25 18:43:00配合的程式、裝置就是這樣搞,也只能特定方式因應
作者:
GOFEN (豬阿布)
2024-12-25 18:43:00傻了嗎? 註解是給自己看的,給別人的都是鳥註解
只在一個層面上做單純一件事的code是這樣但現實在跑的code可能是100層疊起來的邏輯運作
作者:
abadjoke (asyourlife)
2024-12-25 18:44:00自己寫的都不一定看得懂了更何況別人寫的
真的,很多商業邏輯很複雜,文件也不見得齊全,接手的人真的很痛苦
幾百行變數名有寫直白是能不用註解拉 可是超過這數量
作者:
TCPai (荒野遊俠)
2024-12-25 18:44:00複雜的真的需要註解阿,主建構者都不一定記得全部的細節了,其他的更不用說
作者:
orze04 (orz)
2024-12-25 18:44:00你傳狀態只用數字,不寫註解就是在浪費之後接手的人的時間
作者: uohZemllac (甘草精華雄沒醉) 2024-12-25 18:45:00
/*我不知道這幹嘛的 但不要改這個變數 */
作者:
orze04 (orz)
2024-12-25 18:45:00有一種直白叫做自己覺得直白
後幾乎都是分成一堆一堆的模組 這時候還沒註解就GG
作者: kcball 2024-12-25 18:45:00
註解是寫給自己看的
更恐怖的是寫這100層的人都有可能寫出「code實際上會產生但寫的人渾然不知的嚴重後果」
有時候加註解的code才是更坑人的 有些人改完功能沒改註解...
作者:
z635066 (洋蔥)
2024-12-25 18:46:00你到火車站沒時刻表也能上車阿,沒毛病
寫爛又不寫註解的人不該寫CODE,只是來拖累其他人
作者: s12108478 (anthonysu) 2024-12-25 18:46:00
寫得再好也怕疊床架屋阿,該駐就要駐
作者:
babyIam (魚兒水中油)
2024-12-25 18:46:00程式就是文件,一個人寫文件都用自己發明的詞彙然後都不解釋,你感受看看
作者:
arrenwu (鍵盤的戰鬼)
2024-12-25 18:46:00註解寫爛 那PR的 Reviewer要叫她改啊 不能看不懂還送
不過圖中的例子的確是最欠幹的 寫死不註解是最可怕的
作者: sepzako (不及格的懶惰鬼) 2024-12-25 18:47:00
你有沒有要給別人看? 沒有 那你記得就好 有 那你不想被問到煩還是被靠杯就乖乖加 將心比心一下
作者:
spfy (spfy)
2024-12-25 18:47:00西恰到底是有多少工程師
以都給WINDOWS用的來說好了,難道不是詞彙都規定好的
會被修改的東西才有寫註解的必要,使用說明那種該寫的是文檔
作者:
chuegou (chuegou)
2024-12-25 18:48:00當限制來自沒有道理的業務邏輯時 不註解別人根本不知道
作者: leviathen (GO BLUE!) 2024-12-25 18:48:00
寫的好其實不用註解也很好讀,大部分情況都是寫太爛太複雜才加一堆註解
如果你明確知道問題只出在第89層,你可以把寫的人叫出來電,但實際的狀況是裡面可能有10個你根本不知道位置和觸發方法的問題,而且這整坨東西已經在市場中客戶手上天天執行,這時你能相信的只有某島國零食了
作者:
arrenwu (鍵盤的戰鬼)
2024-12-25 18:50:00任何的code 都有可能被修改啊
你是在windows給你的架構之上做事沒錯,但你自己要做的事情可能就有100層邏輯了
作者:
qd6590 (說好吃)
2024-12-25 18:51:00沒註解還可以硬讀 只是很吃力 沒欄位文件的超級靠腰...
作者: dongdong0405 (聿水) 2024-12-25 18:51:00
前提是Code本身寫得有可讀性但偏偏一堆ninja code卻又不註解的
只要這隻程式你過好幾個月回來還是看得懂,或是別人看得懂,以這個概念來說,你要不要寫註解就沒那麼重要,重要的是未來看得懂
作者: lovegensokyo (神戀幻想鄉) 2024-12-25 18:52:00
寫code不註解,連未來的自己都會詛咒你
作者:
linzero (【林】)
2024-12-25 18:52:00但未來的事,沒人能打包票
作者:
qd6590 (說好吃)
2024-12-25 18:52:00我個人只會寫 為什麼要做這件事的註解跟誰叫我改的
我覺得寫註解像是英文作文寫的太差怕人看不懂所以還要附中文翻譯一樣,如果你英文寫得清楚根本不用中文翻譯維護註解等同於維護兩倍的程式碼,最多就寫程式結構或思路就好
作者:
orze04 (orz)
2024-12-25 18:53:00會被修改的東西才有寫註解的必要???除非你敢確定debug時不會碰到
另外一個問題,如果windows現有的架構有會導致不確定性結果的bug,請問你是要用你全部的上班時間打電話去微軟靠夭,還是夾緊你的括約肌,把眼淚吞下去,想盡辦法頂著這個bug還能把你的工作做好?
作者:
s2500205 (KingWon)
2024-12-25 18:53:00涉及到計算方面的,再怎麼好讀回頭再看也記不得為啥要這樣算
作者:
ilohoo (ilohoo)
2024-12-25 18:54:00加註解可以讓原作者和其他人看得懂
我認識的不寫註解又寫得很難懂的,大多他的CODE問題多
作者: lucky0417 (L.W) 2024-12-25 18:54:00
只能說 有多少屎山代碼證明了那些覺得自己寫很好的都……
作者: JUSTMYSUN (小飛蚊) 2024-12-25 18:56:00
///記得刪掉
code夠好不用寫註解 跟很有錢買東西不用看價錢一樣
作者: Shawn5689 (Sion) 2024-12-25 18:56:00
註解是用來記錄違反常理的事情 有些事情不是自己可以決
Kiri大的解釋利好血汗但又真好懂XDD原來是這個意思
作者:
qd6590 (說好吃)
2024-12-25 18:56:00//這邊先這樣 之後再改 去你媽的 之後是什麼時候
看狀況 完全不加 要交接很難 通常命名會很清楚 怕的是abc void a(x) 這種天才
實務上真會出現a,b,c這種變數嗎?這不只寫的人要被幹吧
作者:
orze04 (orz)
2024-12-25 18:58:00有一種好是自己覺得好
我做過6~7間公司 能讓我覺得寫得好不用註解的人沒幾個
我的話 閒的時候會把需求寫進去 忙的時候只註明magicnumber的由來跟用途
作者: su4vu6 2024-12-25 18:58:00
就懶阿 反正也沒人會看
作者:
linzero (【林】)
2024-12-25 18:58:00不過ijk這種有的是用在很多層的迴圈裡吧
作者:
orze04 (orz)
2024-12-25 18:59:00你以為所有公司review都會看那麼仔細嗎?
作者:
NingK (檸~)
2024-12-25 18:59:004,不寫連你自己都看不懂自己寫的
作者:
s2500205 (KingWon)
2024-12-25 19:00:00很多公司不是能執行就過了嗎,誰會逐步執行一行一行看
中大型公司review至少會有一定的程度,那個真的有用
作者: chunfo (龘龘龘) 2024-12-25 19:00:00
未來的你會最恨你
小型的就....你覺得鳥的程式會給熊review嗎 當然沒有
作者: corum68972 (Calxium) 2024-12-25 19:02:00
作者:
Puye (PUYE)
2024-12-25 19:02:00不懶就注一下 別人在看才會比較輕鬆
作者:
s2500205 (KingWon)
2024-12-25 19:02:00當未來要debug的時候確實是那時的你最恨當初的你
作者:
qd6590 (說好吃)
2024-12-25 19:02:00我覺得註解最需要的地方就是接別人爛CODE又沒時間重構的時候 已經花很大力氣好不容易看懂了 一定要寫下來到底在幹麻
作者:
orze04 (orz)
2024-12-25 19:03:00有的公司連git版控都沒有,這版改了什麼還要自己diff
作者:
gate210 (paradox44)
2024-12-25 19:03:00本體盡量寫好 註解只在必要的時候寫就好 不然改code連註解也要一起改也是很麻煩
作者:
andy0121 (投資有賺有賠)
2024-12-25 19:03:00Clean code
作者:
engelba (香腸四郎)
2024-12-25 19:04:00維運到20年前的糞code 就知道有多開心了 有註解至少知道需求是什麼
作者:
yn96503 (一直嘛三小)
2024-12-25 19:06:00別再說寫的好不用加註解了,每個人都嘛自我感覺良好認為自己很會寫很好讀,我帶的案子看到一個註解都沒有誰管你寫什麼一律抓來噴
大公司對程式的要求不是像什麼書本上的美妙範例而是一些類似軍事管理的要求要所有人遵守除非你就是想跟所有人對著幹 否則就乖乖遵守就好對程式無規則要求的職場不會比較好玩
作者:
sakeru (里昂~)
2024-12-25 19:06:00不加註解是要人家通靈喔
作者:
ayuhb (ayuhb)
2024-12-25 19:06:00跟配線不標示線號一樣嗎
作者: lininu (聲音控:P) 2024-12-25 19:06:00
淦你不寫註解數年後回來修,你看得懂或跟別人解釋當時為什麼這樣寫,你就可以不寫註解
作者:
orze04 (orz)
2024-12-25 19:06:00學校時,課程作業會把clean code當評分標準嗎?還是答案對就好?
作者:
s81048112 (**********已加密)
2024-12-25 19:07:00真的 不加註解真的讓人不爽
作者:
arrenwu (鍵盤的戰鬼)
2024-12-25 19:08:00學校的程式作業 註解都馬是交給助教看的 出問題重寫
作者:
louis0724 (louis0724)
2024-12-25 19:08:00可以啊 你就永遠不要讓別人維護 跟自己永遠看得懂自己在幹嘛XD我自己上個月寫的程式我可能就看不懂這什麼狗幹邏輯了
作者:
peefly (Peefly)
2024-12-25 19:09:00text-align: left; /* 客戶說要偏右 */然後你就不知道是客戶又改了還是註解漏改
真的漂亮到一看就讚嘆的code是有可能存在的可是你的無註解code就是被噴了啊 那就是不夠漂亮嘛
作者: Wayne0926 (小安) 2024-12-25 19:10:00
不加 幾個月後來看自己也看不懂了
作者:
deflife (無極而生)
2024-12-25 19:10:00// just magic
作者:
linzero (【林】)
2024-12-25 19:11:00學校的程式作業不會多大且目的明確,不寫註解其實也還好
作者:
arrenwu (鍵盤的戰鬼)
2024-12-25 19:11:00所以才需要reviewer啊
作者:
kingroy (手殘總比腦殘好)
2024-12-25 19:12:00變數名,函數名,class名都取的很標準的,可以不寫或寫很少,但一定規模以上不寫幾乎不可能
可能會有這樣的狀況text-align: left; // 不加的話頁面垂直對齊會失效哪個人敢刪掉這條註解就給我刪看看
作者:
snac (snack)
2024-12-25 19:12:00基本上好的程式看naming要能看出大部分,複雜的才要特別寫註解
註解還好,程式夠乾淨、名子別蝦雞巴取都還看的出來,一個泛型當戰神用才討人厭= =
code review真的不是騙小孩的笑話,它真的有用
作者:
orze04 (orz)
2024-12-25 19:13:00學校作業一堆連排版都壞七八糟
作者:
s971425 (口十日軍)
2024-12-25 19:13:00不加註解只有神或廢物,廢物占99%
作者:
kingroy (手殘總比腦殘好)
2024-12-25 19:13:00有寫接手交接所需的時間比較少,但一般取名取很差的,註解也寫的很差
作者:
linzero (【林】)
2024-12-25 19:13:00不過寫嵌入式系統資源有限之類的,有時變數不能用太多,
作者:
arrenwu (鍵盤的戰鬼)
2024-12-25 19:14:00以前code review我還覺得"幹 怎麼一直要我寫一堆註解"
新人剛進公司的code被評價為矮噁是很正常的不用灰心,遵守規則就好
作者: Kururu8079 2024-12-25 19:14:00
不怕沒有註解,就怕亂註解誤導後續接管的人,整組壞光光
作者:
linzero (【林】)
2024-12-25 19:14:00可能會一個變數多種用途吧
作者:
kingroy (手殘總比腦殘好)
2024-12-25 19:15:00行業標準的註解就去看自動生成文件那些怎寫就知道了
作者:
newasus (我是蘿莉控我自豪)
2024-12-25 19:16:00// 敝公司碼農領的薪水用行數計算
漂亮的程式碼不等於容易看懂的程式碼反而容易讀懂的程式碼 常常是過於冗長打個比方就是好的程式碼就是一個漂亮的公式簡潔又高效沒看過證明 你是要怎麼了解公式怎麼來的?你不了解 怎麼客製優化和調整參數
除非一看就知道在幹嘛,不然還是寫一下吧…半年後自己都看不懂了
作者:
arrenwu (鍵盤的戰鬼)
2024-12-25 19:18:00沒啦 已讀不回應該是 github上面人家留comment你直接啥都不做就按下 resolved這種很容易起糾紛的
作者:
kingroy (手殘總比腦殘好)
2024-12-25 19:19:00一個月後可能換個project就想不起之前在趕嘛
作者: black51002 (不知雲) 2024-12-25 19:19:00
不註解就是後面自己或者接手的人完全看不懂
作者: Anchorage 2024-12-25 19:19:00
不加comment真的有夠夭壽,後人還要通靈通個老半天
作者:
usoko (time to face reality)
2024-12-25 19:19:00看你寫的code好不好懂 但不管再怎麼會寫code的人
作者:
arrenwu (鍵盤的戰鬼)
2024-12-25 19:20:00跟好不好懂沒有關係啊 你開一個新的class 在我讀程式碼前就該有一段文章在描述這class是幹嘛的而不是我要讀了程式碼之後才知道你在幹嘛
作者:
arrenwu (鍵盤的戰鬼)
2024-12-25 19:21:00現在有 Copilot,寫作文比以前方便多了
中心思想就是:好好做個人,讓別人能看懂你的code你要每行都註解還是把87%註解集中在關鍵處就看你反正別人能看懂就沒事,看不懂就一起浪費時間
作者:
usoko (time to face reality)
2024-12-25 19:21:00那看是什麼語言 有必要的話我就在file name跟class name把這個class是做什麼的直接寫完了
作者:
usoko (time to face reality)
2024-12-25 19:22:00你一個class做的事情要用500字來寫不就代表class太大了...
作者:
arrenwu (鍵盤的戰鬼)
2024-12-25 19:22:00document這個東西我想都不敢想了
// 因客戶說他老花眼一直輸錯認證碼因此需要把輸入的值1=I=L,2=Z,5=S
作者:
XFarter (劈哩啪啦碰碰碰)
2024-12-25 19:23:00clean code 的許多準則很好,但不是絕對準則,許多跟算法
作者:
arrenwu (鍵盤的戰鬼)
2024-12-25 19:23:00我上面說了 嘴巴上說會寫document的 不是精英就是騙子
會加但不會有很多 通常是特殊情況會解釋一下 一般來說你的程式碼本來就該寫得讓人看得懂 不然review 怎麼可能會過
作者:
usoko (time to face reality)
2024-12-25 19:23:00但很複雜的多個class我就直接寫module REAME了*README
除非那個 code 沒有其他人要看,而且你自己的記憶力超好,不然即使自己用的 code 都該為了未來的自己寫註解
作者:
ayumi001 (lv.100 的波波)
2024-12-25 19:23:00當你看過註解和程式之間的走向完全不同的時候你就會有另
作者:
arrenwu (鍵盤的戰鬼)
2024-12-25 19:24:00@kirimaru73 不算 你還要告訴我為什麼這裡有吃狗 要幹嘛
作者:
ayumi001 (lv.100 的波波)
2024-12-25 19:24:00一種看法了
作者:
usoko (time to face reality)
2024-12-25 19:24:00自己寫的code大概半年不碰就會忘光了 一定要寫
作者: Arashi0731 (狂舞) 2024-12-25 19:24:00
我也沒在寫註解了,乾淨架構下去,然後變數跟方法命名寫好,基本上看得很清楚
那些我就會直接寫在class Dog的上面了 應該和你期望的一樣
作者:
usoko (time to face reality)
2024-12-25 19:25:00clean architecture有幫助 但不是萬解
作者:
arrenwu (鍵盤的戰鬼)
2024-12-25 19:25:00某種意義上 寫註解就跟買保險很像,這個東西就是盡可能避免未來某一天「幹!!!這到底是三小」的機會但也可能最終發現註解寫得不好所以沒有用但絕對比不寫好得多
作者:
usoko (time to face reality)
2024-12-25 19:26:00我自己的判斷方式 只要nested到一定程度(3層之類) 就一定
作者:
orze04 (orz)
2024-12-25 19:26:00問題不是這段在做什麼,而是為什麼要這麼作
作者:
usoko (time to face reality)
2024-12-25 19:27:00要寫 不然不熟的人絕對浪費時間看
作者: Arashi0731 (狂舞) 2024-12-25 19:27:00
重點把是你的架構訂好,依循著架構放檔案,各種依賴跟參考都有照著規則比寫一堆狗屎註解重要
作者:
orze04 (orz)
2024-12-25 19:28:00大型project最後都難免變違章建築
作者:
usoko (time to face reality)
2024-12-25 19:29:00這年頭lint都會檢查啊 即便如此還是有可能寫得很複雜
作者:
amsmsk (449)
2024-12-25 19:30:00不加註解自己也會看不懂吧
作者:
LeoYuri (LeoYuri)
2024-12-25 19:30:00不加註解,我還真的無法一瞬間看出來在幹嘛
作者: alaf (羽月楓花) 2024-12-25 19:30:00
一個月前的自己:自己寫的一定懂 一個月後的我:這段是啥鬼
作者:
kctrl (小瓜呆)
2024-12-25 19:31:00自己的程式加註解都要思考幾分鐘在幹嘛了,更不用說別人的我相信世界上有天才不需要註解,但那個人絕對不是我
作者:
abd86731 (HSEric)
2024-12-25 19:33:00比不簽聯絡簿還噁心
有一派是code好不用註解,但現實通常是隨時間跟經手的人變多gg
作者:
dnkofe (赤空)
2024-12-25 19:35:00看你的程式別人需不需要用,需要的話還是要註解
作者:
alpho (Whyyyyy)
2024-12-25 19:36:00雖然取名能解決很多閱讀問題 但註解可以直接省下這些問題,特別是遇到取名new或是obj的人
作者:
orze04 (orz)
2024-12-25 19:36:00還有一種是註解裡故意埋炸彈給接手的垃圾
作者:
ilohoo (ilohoo)
2024-12-25 19:38:00寫code的動機是“客戶說”那就註定好不了。乖乖把“客戶希望能夠1+1=5”寫在註解上
作者:
b325019 (望月)
2024-12-25 19:40:00不寫註解一樣能埋炸彈特例就別說了
作者:
andy3231 (清大小勞勃道尼)
2024-12-25 19:40:00看過一本講refactor的有提到盡量不要寫註釋,只有特殊情況才要寫
作者:
s2500205 (KingWon)
2024-12-25 19:40:00一堆亂七八糟的調整都嘛是來自“客戶要求”,別想會多好
作者: six93250 (茶裏王) 2024-12-25 19:41:00
除非整個團隊英文能力都很好,不然clean code的意思是變數與函式的命名要清楚到能直接看懂程式的意思
作者:
andy3231 (清大小勞勃道尼)
2024-12-25 19:42:00我同事兩百行code有一百行是註釋不知道在衝三小
作者: lucky0417 (L.W) 2024-12-25 19:42:00
這個問題其實很簡單 現在回去翻自己幾年前寫的 測測自己不看註解的情況下要用多久能全理解
當然有些特例 像是寫random但實際上有加權時就要註解
作者: lylu (理路) 2024-12-25 19:42:00
除了註解本來就有很多地方可以記錄資訊啊 你commit msg也是要寫清楚 clean code就是追求程式碼本身就是註解 function跟class名稱都要有意義
作者: six93250 (茶裏王) 2024-12-25 19:43:00
但大多數人連命名都亂七八糟的
作者: FCPo011674 (文) 2024-12-25 19:45:00
我是覺得可以讓命名、結構易懂比寫註解重要,不然程式
作者: tuwulisu6111 2024-12-25 19:45:00
有時註解反而在騙人 不如專注在把命名做好
作者:
odanaga (PixiyON)
2024-12-25 19:45:00寫很爛又沒註解 就王八蛋
作者: ARTORIA 2024-12-25 19:46:00
看不看得懂是一回事 寫了是幫之後看的人省時間就算code寫得好懂 每次重看也是浪費時間
作者:
wzmildf (我ä¸æ˜¯è˜¿èŽ‰æŽ§)
2024-12-25 19:46:00有自信永遠不帶給自己和他人困擾就別加,我連一個月前自己在excel寫的VBA 都可能看不懂
作者:
bdenken (想學畫畫啊!!!)
2024-12-25 19:47:00Chatgpt 都會寫好註解
作者:
togs (= =")
2024-12-25 19:47:00自己寫的都不一定記得了。
我看現在大師的說法是追求程式的可讀性要高,夠高的話不註解也很清楚
作者:
ohohohya (安安你好我草泥馬)
2024-12-25 19:48:00我都有git了還註解啥
作者: s56565566123 (OnlyRumble) 2024-12-25 19:48:00
真的寫到很簡單根本不用註解
除非你是那種Code可讀性極高 誰來都能馬上理解的神人
作者: lylu (理路) 2024-12-25 19:49:00
不然就build script最後加doxygen 沒寫直接build fail
commit msg跟README還有design doc都可以寫
作者:
oread168 (大地的精éˆR)
2024-12-25 19:50:00然後變數用ABCD1234不命名 爽不爽
作者:
e2ne0 (e2ne00)
2024-12-25 19:50:00命名就知道是在幹嘛了 幹嘛還要註解==
作者:
Dayton (今夜如此,夜夜皆然。)
2024-12-25 19:51:00對 超級
寧願加註解也不要相信自己看得懂自己的東西你自己寫的日記都有可能不知道你在寫什麼更何況是代碼
作者: keichi (旅行的話你想去哪) 2024-12-25 19:52:00
其實不會
作者:
Beltran (グル≡崩壊)
2024-12-25 19:52:002025還有人把clean code當聖經 幾年前就戰過了
作者:
ltytw (ltytw)
2024-12-25 19:52:00寫代碼不加註解。就算只有自己會看也是一段時間連自己都看不懂
寫得再好也不可能理解起來比註解還好吧,註解都亂寫的他程式會好好寫嗎...
作者: plamosuki 2024-12-25 19:54:00
寫註解就是要告知這坨大便是什麼原因產生的啊
作者:
AlphaMC (偶爾出聲)
2024-12-25 19:55:00看你是當個人日記還是出版書籍來寫啊,只是個人日記過幾個月連自己都不知道在寫什麼了
作者:
Bf109G6 (Luftwaffe)
2024-12-25 19:55:00issue解一解 忙了半年之後回頭過來看 就忘記我在幹嘛了
作者:
yys310 (有水當思無水之苦)
2024-12-25 19:55:00三個月後自己看都忘記了
作者: FCPo011674 (文) 2024-12-25 19:56:00
這麼說好了,寫出易懂的程式是一個理想;但現實是不可能完全達到的,不管是有特殊邏輯,或是寫的東西並沒有那麼好懂。一定或多或少要有註解輔助其實註解寫的好不代表原始碼會多花,我遇過一個leader註解寫很勤且很多,也要求底下的人照做;但我接手他的code後改到快吐了*多好
作者:
shinchen (starrydawn星晨)
2024-12-25 19:59:00偏底層的程式要搞加速或省資源的時候就管不了可讀性了
作者: Void956 (shitblack) 2024-12-25 19:59:00
有時候註解說的是一回事,程式碼寫的卻是另一回事,所以註解真的比較好嗎?
作者:
Dlareme (:D)
2024-12-25 20:00:00不用三個月 忙一點同時兩三個案子 下個禮拜就忘了
作者:
as6633208 (okokokiknow)
2024-12-25 20:00:00其實,真正優秀的團隊,是真的不用註解,含在design pattern惹..
作者: FCPo011674 (文) 2024-12-25 20:00:00
各種惡用巢狀迴圈,即使裡面寫了滿滿的註解,我還是很難修;最後我就直接打掉重寫了
遇過資深工程師意見超多+話超多+文件超長,但是一半左右是廢話的
作者:
as6633208 (okokokiknow)
2024-12-25 20:01:00無註解是比較理想化,實際有些東西還是要註解會比較清楚
作者: chris510127 (盧A) 2024-12-25 20:01:00
你兩個月後回去看自己的程式就差不多忘了
作者: ARTORIA 2024-12-25 20:02:00
不可能無註解比較好啊 你有註解你的程式碼我不用全懂
實際上一定會需要註解,大部分是用在special case or workaround
作者:
Jimmywin (Dilemma)
2024-12-25 20:02:00連自己都看不懂
作者:
shinchen (starrydawn星晨)
2024-12-25 20:03:00搞底層韌體有時候會需要計較這段code怎麼寫編出來可以少幾個指令或多少RAM 這種不留註解沒人知道你幹嘛這樣做
作者: Syalon ((`・ω・′)) 2024-12-25 20:04:00
這串吊出一堆寫扣大佬
作者: Void956 (shitblack) 2024-12-25 20:05:00
我自己寫程式也是偏向少註解,因為用code說話比較好。
作者: sustto (sustto) 2024-12-25 20:06:00
4
我自己是無法理解自己看不懂這件事啦,可能我的思考迴路是基本很難變動的那種
自己寫得看久了當然會看懂,只是你要花多少時間去看寫註解可以幫助自己回想的快很多
作者: ARTORIA 2024-12-25 20:11:00
對阿 懂不懂是一回事 主要是省時
說寫Code不用註解的,都是待在同事都是高手,離職率超
作者: pumapupa 2024-12-25 20:13:00
有些狀況是寫理由 看得懂code也不一定知道為甚麼這樣寫
作者:
tmwolf (魯神)
2024-12-25 20:13:00超靠北
大神寫出來的就算加註解一般人也看不懂 邏輯完全跟不上
我待過沒Code Review的公司,接手離職人員的專案,我只想寄一箱手榴彈去問候他
作者:
tmwolf (魯神)
2024-12-25 20:17:00本篇講的就是寫死的,寫死又不留註解,後面接力的人大家都要當通靈王
作者:
jack529 (Jack)
2024-12-25 20:19:00如果有workaround 或是 複雜邏輯 沒加就垃圾人
作者:
pantani (我也想當綠手指)
2024-12-25 20:19:00就像你創出一道菜沒做筆記某天上了菜單 別說要同事復刻連自己都不一定記得調味的份量
作者: driver0811 (Hu Hu前進) 2024-12-25 20:20:00
TODO 需要增加註解