PTT評價

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

看板Soft_Job標題[討論] 關於中文註釋的使用作者
tbpfs
( http://pse.is/tbpfs )
時間推噓25 推:27 噓:2 →:41

有鑑於 上一篇文章 #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 留言評論
※ 發信站: 批踢踢實業坊(ptt.cc), 來自: 61.227.47.250 (臺灣)
PTT 網址

cryinglove05/22 11:23曾經聽過某跨國企業,註解有日文韓文泰文中文英文,感

cryinglove05/22 11:23覺很容易崩潰的(人心崩潰

abc092200105/22 11:42我只有在 commit message 的第三行後會用中文

alihue05/22 11:44這有什麼好討論的,不久看會不會跟外國人合作決定就好

pilor05/22 12:02好的

JasperChang05/22 12:31如果異質母語合作人數少 當然請他們自己想辦法

JasperChang05/22 12:32中文注釋以前怕亂碼而已

Csongs05/22 12:50跟中國同仁合作過,有人用漢語拼音當變數就是..

Csongs05/22 12:54就看公司規定吧 規定英文就用英文

godddddd05/22 13:40我3 不介意中文 只介意產品上線沒

pttworld05/22 14:08與其討論中文,為什麼不討論德國工程師用德文

pttworld05/22 14:09team需要共通的語言就是英文,反之各國用各國的語言

kvjo05/22 14:12鈦坦 放 頂級? 以我知道的 雖然開出很多號稱200~300的缺

kvjo05/22 14:12但不少工程師 是100以內的 100以上 大多要 "配合call"

kvjo05/22 14:13而且 所謂的新加玻泰坦.... 除了博奕遊戲外 有做別的嗎?

kvjo05/22 14:19多數人在台灣做軟體 應該只處於80-130之間

kvjo05/22 14:19台北資深一些 可以再上去一些

luke7205/22 14:343,4才是最多用中文註釋的 例如各種包案的開發商

luke7205/22 14:36有跟中國合作或者外包給中國的 簡體字註釋很常見

wulouise05/22 14:45我公司也是要求英文註解,原因是不能寫太複雜

NDark05/22 14:49如果編譯環境不行。那當然不行。

NDark05/22 14:52環境允許。那我可以接受英中並列/依需求補齊註解。

NDark05/22 14:52依需求就是 當有人看不懂的時候,就是時候安排時間寫註解。

NDark05/22 14:53就跟文件的問題一樣。永遠都不可能寫到滿分。

NDark05/22 14:53但是無法寫到滿分並不構成不寫註解的充分理由

NDark05/22 14:54以目前的資源該寫多少,哪些先寫。才是務實的做法。

dong53105/22 15:064.沒有要求,我的案子都寫中文,註解是用來溝通的,能讓

dong53105/22 15:06人快速了解程式就好

asleisureto05/22 15:17弄錯順序了吧,是進了頂級公司要用英文注釋,而不是

asleisureto05/22 15:17用了英文注釋就能進頂級公司

NDark05/22 15:23樓上有一種東西叫做舒適圈

vi00024605/22 16:13//這行到底在衝三小 別逼我用blame

king2264905/22 16:14很好奇 用中文註釋 是不是沒有 code review 的文化?

xo110005/22 16:24頂級公司給出待遇待遇捏著LP遵守沒問題啊

xo110005/22 16:26*頂級

xo110005/22 16:29除非工作環境全部英文溝通不然到底有啥好嘴的

devilkool05/22 16:35笑了 干code review啥事

oyaji556605/22 16:38註解也要支援多語系

king2264905/22 16:49code review 文化啊~

Nonegrame05/22 17:02很好奇 有 code review 是不是沒有中文註解?

lazarus112105/22 17:22哼 我本來連變數都想取中文

zexon9705/22 17:35哪個大陸

william8161505/22 18:19當你要面對孤兒程式,上面還有一堆前人遺留的破英

william8161505/22 18:19文註解時,我認為寫中文註解沒什麼不好

v7q405/22 18:48visual studio範例程式的註解都有中文了

sxy6723005/22 19:10我都用中文寫變數跟函數類別名稱

peanut9705/22 19:32推29樓,因果關係清楚

Csongs05/22 19:37code review 跟註解用什麼語言沒關吧

Csongs05/22 19:37只能說用英文別人比較沒什麼意見而已

king2264905/22 20:01個人是跟著google做 版上還有google code review m文

king2264905/22 20:03不用英文的原因大多是英文爛 不過我看google流程 也有

king2264905/22 20:03review這項 所以很好奇 其他人review到底都做了啥 如果

king2264905/22 20:03有 是不是就可以避免這種問題

king2264905/22 20:04壓根就沒review的話 code裡有甚麼奇怪東西 都是正常的

JasperChang05/22 20:14Google 自己提交的程式碼都良莠不齊了 算了吧

Darkword198705/22 22:58寫中文國外工程師看不懂 寫英文大家都看不懂 GG

azureroki05/22 23:52為啥註解不能用i18n翻譯

tennyleaz05/23 00:45中國廠商code一堆簡體字,還用GBK編碼不用unicode存@@

xvid05/23 00:55一堆人不知道文字編碼,最後亂存變亂碼

azzc103105/23 01:42在外商 windows系統是全英文的 想寫中文也沒辦法xd

Hitmear05/23 10:53目前在3當lead,說一下我的想法,好的code不太需要註解,

Hitmear05/23 10:53註解只需要留真正核心的提示,那英文就足夠表達了

labbat05/23 11:35好的code要self-documented

NDark05/23 12:17核心提示是什麼? 還是註解XD

v7q405/23 18:34還有同事用中文拼音來命名… 算權重的function他用chiuanChu

v7q405/23 18:34ng()

spfy05/23 18:44https://i.imgur.com/QdO4bqq.png 沒事兒 習慣26就好

wulouise05/24 13:05拼音縮寫跟注音文一樣難懂

watashino05/25 05:37寫code的時候中文輸入法根本礙事

watashino05/25 05:37要用中文注釋的話效率感覺爆低