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

[tbpfs ( http://pse.is/tbpfs )]

有鑑於 上一篇文章 #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:一人工作室的話，要用什麼語言寫註釋是自己的自由，要用克林貢語也行

--
紫楓碎碎念
YouTube頻道：https://www.youtube.com/user/tbpfs

FB粉專：https://www.facebook.com/tbpfs2/

blog: http://tbpfs1.blogspot.com/

--
※ 發信站: 批踢踢實業坊(ptt.cc), 來自: 61.227.47.250 (臺灣)
※ 文章網址: https://www.ptt.cc/bbs/Soft_Job/M.1590117453.A.C9A.html
推 cryinglove: 曾經聽過某跨國企業，註解有日文韓文泰文中文英文，感
→ cryinglove: 覺很容易崩潰的（人心崩潰
推 abc0922001: 我只有在 commit message 的第三行後會用中文
推 alihue: 這有什麼好討論的，不久看會不會跟外國人合作決定就好
噓 pilor: 好的
→ JasperChang: 如果異質母語合作人數少 當然請他們自己想辦法
→ JasperChang: 中文注釋以前怕亂碼而已
推 Csongs: 跟中國同仁合作過，有人用漢語拼音當變數就是..
推 Csongs: 就看公司規定吧 規定英文就用英文
→ godddddd: 我3 不介意中文 只介意產品上線沒
→ pttworld: 與其討論中文，為什麼不討論德國工程師用德文
→ pttworld: team需要共通的語言就是英文，反之各國用各國的語言
→ kvjo: 鈦坦 放 頂級?  以我知道的 雖然開出很多號稱200~300的缺
→ kvjo: 但不少工程師 是100以內的  100以上  大多要 "配合call"
→ kvjo: 而且 所謂的新加玻泰坦.... 除了博奕遊戲外 有做別的嗎?
→ kvjo: 多數人在台灣做軟體 應該只處於80-130之間
→ kvjo: 台北資深一些 可以再上去一些
推 luke72: 3,4才是最多用中文註釋的  例如各種包案的開發商
→ luke72: 有跟中國合作或者外包給中國的  簡體字註釋很常見
推 wulouise: 我公司也是要求英文註解，原因是不能寫太複雜
推 NDark: 如果編譯環境不行。那當然不行。
→ NDark: 環境允許。那我可以接受英中並列/依需求補齊註解。
→ NDark: 依需求就是 當有人看不懂的時候，就是時候安排時間寫註解。
→ NDark: 就跟文件的問題一樣。永遠都不可能寫到滿分。
→ NDark: 但是無法寫到滿分並不構成不寫註解的充分理由
→ NDark: 以目前的資源該寫多少，哪些先寫。才是務實的做法。
推 dong531: 4.沒有要求，我的案子都寫中文，註解是用來溝通的，能讓
→ dong531: 人快速了解程式就好
推 asleisureto: 弄錯順序了吧，是進了頂級公司要用英文注釋，而不是
→ asleisureto: 用了英文注釋就能進頂級公司
推 NDark: 樓上有一種東西叫做舒適圈
推 vi000246: //這行到底在衝三小 別逼我用blame
推 king22649: 很好奇 用中文註釋 是不是沒有 code review 的文化？
→ xo1100: 頂級公司給出待遇待遇捏著LP遵守沒問題啊
→ xo1100: *頂級
→ xo1100: 除非工作環境全部英文溝通不然到底有啥好嘴的
→ devilkool: 笑了 干code review啥事
推 oyaji5566: 註解也要支援多語系
推 king22649: code review 文化啊～
→ Nonegrame: 很好奇 有 code review 是不是沒有中文註解？
→ lazarus1121: 哼  我本來連變數都想取中文
噓 zexon97: 哪個大陸
→ william81615: 當你要面對孤兒程式，上面還有一堆前人遺留的破英
→ william81615: 文註解時，我認為寫中文註解沒什麼不好
推 v7q4: visual studio範例程式的註解都有中文了
推 sxy67230: 我都用中文寫變數跟函數類別名稱
推 peanut97: 推29樓，因果關係清楚
→ Csongs: code review 跟註解用什麼語言沒關吧
→ Csongs: 只能說用英文別人比較沒什麼意見而已
推 king22649: 個人是跟著google做 版上還有google code review m文
→ king22649: 不用英文的原因大多是英文爛 不過我看google流程 也有
→ king22649: review這項 所以很好奇 其他人review到底都做了啥 如果
→ king22649: 有 是不是就可以避免這種問題
→ king22649: 壓根就沒review的話 code裡有甚麼奇怪東西 都是正常的
→ JasperChang: Google 自己提交的程式碼都良莠不齊了 算了吧
→ Darkword1987: 寫中文國外工程師看不懂 寫英文大家都看不懂 GG
推 azureroki: 為啥註解不能用i18n翻譯
推 tennyleaz: 中國廠商code一堆簡體字，還用GBK編碼不用unicode存@@
推 xvid: 一堆人不知道文字編碼，最後亂存變亂碼
推 azzc1031: 在外商 windows系統是全英文的 想寫中文也沒辦法xd
推 Hitmear: 目前在3當lead，說一下我的想法，好的code不太需要註解，
→ Hitmear: 註解只需要留真正核心的提示，那英文就足夠表達了
→ labbat: 好的code要self-documented
推 NDark: 核心提示是什麼？ 還是註解ＸＤ
推 v7q4: 還有同事用中文拼音來命名… 算權重的function他用chiuanChu
→ v7q4: ng()
→ spfy: https://i.imgur.com/QdO4bqq.png 沒事兒 習慣26就好
推 wulouise: 拼音縮寫跟注音文一樣難懂
→ watashino: 寫code的時候中文輸入法根本礙事
→ watashino: 要用中文注釋的話效率感覺爆低