[討論] 關於中文註釋的使用

作者: tbpfs (http://0rz.tw/Uk989)   2020-05-22 11:17:30
有鑑於 上一篇文章 #1UndCGvN 的討論偏掉了
而且很有趣的都偏到了關於中文註釋的地方
所以想說跟大家討論看看中文註釋的部分
尤其是看到許多人似乎還蠻常用中文註釋
先來說說我的看法
其實因為很多工程師的英文不好,寫出來的英文註釋實在難懂
所以我最早是支持中文註釋的
直到我膝蓋中了一箭
被主管直接打槍
理由很簡單,公司裡有外國工程師
但其實講句難聽一點的,基本上這個程式只有我們team會看
幾乎不會給到外國人看,不過專案這種東西交接來交接去
誰能保證最後交給誰呢?
然後另外有人說
純台灣公司可以寫中文註釋
讓我想到了一篇文章
台灣軟體業業界現況詳解、軟體工程師指南
http://l.ovoy.click/NL66G
它裡面對台灣公司的薪資做了一個排序
1. 頂級或準頂級真外商
2. 頂級知名新創、優質新創
3. 知名大型軟體公司、已本土化的假外商、還行的新創
4. 傳統大公司
5. 做不太起來的新創、假新創、很小的新創
6. 其他小資型小公司
他有免責聲明 這份名單排序不是絕對,有非常多特例,稍後會舉一些
因為能不能用中文註釋,其實我覺得還是看公司文化
1是絕對不行的,因為都是跨國合作
我待過4,就是之前被打槍的經歷
那我不確定2和3是否可以用中文註釋
我直覺認為可以用中文註釋的公司大概都位於5.6 (歡迎2.3的人來打臉)
結論很簡單: 如果想要追求高薪工作的話,還是乖乖用英文註釋吧
PS 1:這裡僅對台灣而言,或許大陸正流行簡體字註釋也說不定
PS 2:一人工作室的話,要用什麼語言寫註釋是自己的自由,要用克林貢語也行
作者: cryinglove (毓™)   2020-05-22 11:23:00
曾經聽過某跨國企業,註解有日文韓文泰文中文英文,感覺很容易崩潰的(人心崩潰
作者: abc0922001 (中士abc)   2020-05-22 11:42:00
我只有在 commit message 的第三行後會用中文
作者: alihue (wanda wanda)   2020-05-22 11:44:00
這有什麼好討論的,不久看會不會跟外國人合作決定就好
作者: pilor (Formosa)   2020-05-22 12:02:00
好的
作者: JasperChang (PeterChou)   2020-05-22 12:31:00
如果異質母語合作人數少 當然請他們自己想辦法中文注釋以前怕亂碼而已
作者: Csongs (西歌)   2020-05-22 12:50:00
跟中國同仁合作過,有人用漢語拼音當變數就是..就看公司規定吧 規定英文就用英文
作者: godddddd (howudoing)   2020-05-22 13:40:00
我3 不介意中文 只介意產品上線沒
作者: pttworld (批踢踢世界)   2020-05-22 14:08:00
與其討論中文,為什麼不討論德國工程師用德文team需要共通的語言就是英文,反之各國用各國的語言
作者: kvjo (同名專輯)   2020-05-22 14:12:00
鈦坦 放 頂級? 以我知道的 雖然開出很多號稱200~300的缺但不少工程師 是100以內的 100以上 大多要 "配合call"而且 所謂的新加玻泰坦.... 除了博奕遊戲外 有做別的嗎?多數人在台灣做軟體 應該只處於80-130之間台北資深一些 可以再上去一些
作者: luke72 (ccc)   2020-05-22 14:34:00
3,4才是最多用中文註釋的 例如各種包案的開發商有跟中國合作或者外包給中國的 簡體字註釋很常見
作者: wulouise (在線上!=在電腦前)   2020-05-22 14:45:00
我公司也是要求英文註解,原因是不能寫太複雜
作者: NDark (溺於黑暗)   2020-05-22 14:49:00
如果編譯環境不行。那當然不行。環境允許。那我可以接受英中並列/依需求補齊註解。依需求就是 當有人看不懂的時候,就是時候安排時間寫註解。就跟文件的問題一樣。永遠都不可能寫到滿分。但是無法寫到滿分並不構成不寫註解的充分理由
作者: dong531 (貓王)   2020-05-22 15:06:00
4.沒有要求,我的案子都寫中文,註解是用來溝通的,能讓人快速了解程式就好
作者: asleisureto (ASLE)   2020-05-22 15:17:00
弄錯順序了吧,是進了頂級公司要用英文注釋,而不是用了英文注釋就能進頂級公司
作者: NDark (溺於黑暗)   2020-05-22 15:23:00
樓上有一種東西叫做舒適圈
作者: vi000246 (Vi)   2020-05-22 16:13:00
//這行到底在衝三小 別逼我用blame
作者: king22649   2020-05-22 16:14:00
很好奇 用中文註釋 是不是沒有 code review 的文化?
作者: xo1100 (蝦蒸河粉)   2020-05-22 16:24:00
頂級公司給出待遇待遇捏著LP遵守沒問題啊*頂級除非工作環境全部英文溝通不然到底有啥好嘴的
作者: devilkool (對貓毛過敏的貓控)   2020-05-22 16:35:00
笑了 干code review啥事
作者: oyaji5566 (大叔56)   2020-05-22 16:38:00
註解也要支援多語系
作者: king22649   2020-05-22 16:49:00
code review 文化啊~
作者: Nonegrame (程式寫得好,好人做到老)   2020-05-22 17:02:00
很好奇 有 code review 是不是沒有中文註解?
作者: lazarus1121 (...)   2020-05-22 17:22:00
哼 我本來連變數都想取中文
作者: zexon97 (過渡期)   2020-05-22 17:35:00
哪個大陸
作者: william81615 (別這樣玩我)   2020-05-22 18:19:00
當你要面對孤兒程式,上面還有一堆前人遺留的破英文註解時,我認為寫中文註解沒什麼不好
作者: v7q4 ((.)(.)乳劍雙修 -|=>)   2020-05-22 18:48:00
visual studio範例程式的註解都有中文了
作者: sxy67230 (charlesgg)   2020-05-22 19:10:00
我都用中文寫變數跟函數類別名稱
作者: peanut97 (丁丁)   2020-05-22 19:32:00
推29樓,因果關係清楚
作者: Csongs (西歌)   2020-05-22 19:37:00
code review 跟註解用什麼語言沒關吧只能說用英文別人比較沒什麼意見而已
作者: king22649   2020-05-22 20:01:00
個人是跟著google做 版上還有google code review m文不用英文的原因大多是英文爛 不過我看google流程 也有review這項 所以很好奇 其他人review到底都做了啥 如果有 是不是就可以避免這種問題壓根就沒review的話 code裡有甚麼奇怪東西 都是正常的
作者: JasperChang (PeterChou)   2020-05-22 20:14:00
Google 自己提交的程式碼都良莠不齊了 算了吧
作者: Darkword1987 (黑字)   2020-05-22 22:58:00
寫中文國外工程師看不懂 寫英文大家都看不懂 GG
作者: azureroki (Roki)   2020-05-22 23:52:00
為啥註解不能用i18n翻譯
作者: tennyleaz (tenny)   2020-05-23 00:45:00
中國廠商code一堆簡體字,還用GBK編碼不用unicode存@@
作者: xvid (DivX)   2020-05-23 00:55:00
一堆人不知道文字編碼,最後亂存變亂碼
作者: azzc1031 (azzc1031)   2020-05-23 01:42:00
在外商 windows系統是全英文的 想寫中文也沒辦法xd
作者: Hitmear (屍殌化液)   2020-05-23 10:53:00
目前在3當lead,說一下我的想法,好的code不太需要註解,註解只需要留真正核心的提示,那英文就足夠表達了
作者: labbat (labbat)   2020-05-23 11:35:00
好的code要self-documented
作者: NDark (溺於黑暗)   2020-05-23 12:17:00
核心提示是什麼? 還是註解XD
作者: v7q4 ((.)(.)乳劍雙修 -|=>)   2020-05-23 18:34:00
還有同事用中文拼音來命名… 算權重的function他用chiuanChung()
作者: spfy (spfy)   2020-05-23 18:44:00
https://i.imgur.com/QdO4bqq.png 沒事兒 習慣26就好
作者: wulouise (在線上!=在電腦前)   2020-05-24 13:05:00
拼音縮寫跟注音文一樣難懂
作者: watashino (我同學數學很爛)   2020-05-25 05:37:00
寫code的時候中文輸入法根本礙事要用中文注釋的話效率感覺爆低

Links booklink

Contact Us: admin [ a t ] ucptt.com