PTT職涯區 / Soft_Job (軟體人)

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

看板Soft_Job (軟體人)作者 ( http://pse.is/tbpfs )時間5年前 (2020/05/22 11:17), 編輯推噓25(27推 2噓 41→)
留言70則, 35人參與, 5年前最新討論串1/1
有鑑於 上一篇文章 #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
推
05/22 11:23, 5年前 , 1F
曾經聽過某跨國企業，註解有日文韓文泰文中文英文，感
05/22 11:23, 1F
→
05/22 11:23, 5年前 , 2F
覺很容易崩潰的（人心崩潰
05/22 11:23, 2F
推
05/22 11:42, 5年前 , 3F
我只有在 commit message 的第三行後會用中文
05/22 11:42, 3F
推
05/22 11:44, 5年前 , 4F
這有什麼好討論的，不久看會不會跟外國人合作決定就好
05/22 11:44, 4F
噓
05/22 12:02, 5年前 , 5F
好的
05/22 12:02, 5F
→
05/22 12:31, 5年前 , 6F
如果異質母語合作人數少 當然請他們自己想辦法
05/22 12:31, 6F
→
05/22 12:32, 5年前 , 7F
中文注釋以前怕亂碼而已
05/22 12:32, 7F
推
05/22 12:50, 5年前 , 8F
跟中國同仁合作過，有人用漢語拼音當變數就是..
05/22 12:50, 8F
推
05/22 12:54, 5年前 , 9F
就看公司規定吧 規定英文就用英文
05/22 12:54, 9F
→
05/22 13:40, 5年前 , 10F
我3 不介意中文 只介意產品上線沒
05/22 13:40, 10F
→
05/22 14:08, 5年前 , 11F
與其討論中文，為什麼不討論德國工程師用德文
05/22 14:08, 11F
→
05/22 14:09, 5年前 , 12F
team需要共通的語言就是英文，反之各國用各國的語言
05/22 14:09, 12F
→
05/22 14:12, 5年前 , 13F
鈦坦 放 頂級? 以我知道的 雖然開出很多號稱200~300的缺
05/22 14:12, 13F
→
05/22 14:12, 5年前 , 14F
但不少工程師 是100以內的 100以上 大多要 "配合call"
05/22 14:12, 14F
→
05/22 14:13, 5年前 , 15F
而且 所謂的新加玻泰坦.... 除了博奕遊戲外 有做別的嗎?
05/22 14:13, 15F
→
05/22 14:19, 5年前 , 16F
多數人在台灣做軟體 應該只處於80-130之間
05/22 14:19, 16F
→
05/22 14:19, 5年前 , 17F
台北資深一些 可以再上去一些
05/22 14:19, 17F
推
05/22 14:34, 5年前 , 18F
3,4才是最多用中文註釋的 例如各種包案的開發商
05/22 14:34, 18F
→
05/22 14:36, 5年前 , 19F
有跟中國合作或者外包給中國的 簡體字註釋很常見
05/22 14:36, 19F
推
05/22 14:45, 5年前 , 20F
我公司也是要求英文註解，原因是不能寫太複雜
05/22 14:45, 20F
推
05/22 14:49, 5年前 , 21F
如果編譯環境不行。那當然不行。
05/22 14:49, 21F
→
05/22 14:52, 5年前 , 22F
環境允許。那我可以接受英中並列/依需求補齊註解。
05/22 14:52, 22F
→
05/22 14:52, 5年前 , 23F
依需求就是 當有人看不懂的時候，就是時候安排時間寫註解。
05/22 14:52, 23F
→
05/22 14:53, 5年前 , 24F
就跟文件的問題一樣。永遠都不可能寫到滿分。
05/22 14:53, 24F
→
05/22 14:53, 5年前 , 25F
但是無法寫到滿分並不構成不寫註解的充分理由
05/22 14:53, 25F
→
05/22 14:54, 5年前 , 26F
以目前的資源該寫多少，哪些先寫。才是務實的做法。
05/22 14:54, 26F
推
05/22 15:06, 5年前 , 27F
4.沒有要求，我的案子都寫中文，註解是用來溝通的，能讓
05/22 15:06, 27F
→
05/22 15:06, 5年前 , 28F
人快速了解程式就好
05/22 15:06, 28F
推
05/22 15:17, 5年前 , 29F
弄錯順序了吧，是進了頂級公司要用英文注釋，而不是
05/22 15:17, 29F
→
05/22 15:17, 5年前 , 30F
用了英文注釋就能進頂級公司
05/22 15:17, 30F
推
05/22 15:23, 5年前 , 31F
樓上有一種東西叫做舒適圈
05/22 15:23, 31F
推
05/22 16:13, 5年前 , 32F
//這行到底在衝三小 別逼我用blame
05/22 16:13, 32F
推
05/22 16:14, 5年前 , 33F
很好奇 用中文註釋 是不是沒有 code review 的文化？
05/22 16:14, 33F
→
05/22 16:24, 5年前 , 34F
頂級公司給出待遇待遇捏著LP遵守沒問題啊
05/22 16:24, 34F
→
05/22 16:26, 5年前 , 35F
*頂級
05/22 16:26, 35F
→
05/22 16:29, 5年前 , 36F
除非工作環境全部英文溝通不然到底有啥好嘴的
05/22 16:29, 36F
→
05/22 16:35, 5年前 , 37F
笑了 干code review啥事
05/22 16:35, 37F
推
05/22 16:38, 5年前 , 38F
註解也要支援多語系
05/22 16:38, 38F
推
05/22 16:49, 5年前 , 39F
code review 文化啊～
05/22 16:49, 39F
→
05/22 17:02, 5年前 , 40F
很好奇 有 code review 是不是沒有中文註解？
05/22 17:02, 40F
→
05/22 17:22, 5年前 , 41F
哼 我本來連變數都想取中文
05/22 17:22, 41F
噓
05/22 17:35, 5年前 , 42F
哪個大陸
05/22 17:35, 42F
→
05/22 18:19, 5年前 , 43F
當你要面對孤兒程式，上面還有一堆前人遺留的破英
05/22 18:19, 43F
→
05/22 18:19, 5年前 , 44F
文註解時，我認為寫中文註解沒什麼不好
05/22 18:19, 44F
推
05/22 18:48, 5年前 , 45F
visual studio範例程式的註解都有中文了
05/22 18:48, 45F
推
05/22 19:10, 5年前 , 46F
我都用中文寫變數跟函數類別名稱
05/22 19:10, 46F
推
05/22 19:32, 5年前 , 47F
推29樓，因果關係清楚
05/22 19:32, 47F
→
05/22 19:37, 5年前 , 48F
code review 跟註解用什麼語言沒關吧
05/22 19:37, 48F
→
05/22 19:37, 5年前 , 49F
只能說用英文別人比較沒什麼意見而已
05/22 19:37, 49F
推
05/22 20:01, 5年前 , 50F
個人是跟著google做 版上還有google code review m文
05/22 20:01, 50F
→
05/22 20:03, 5年前 , 51F
不用英文的原因大多是英文爛 不過我看google流程 也有
05/22 20:03, 51F
→
05/22 20:03, 5年前 , 52F
review這項 所以很好奇 其他人review到底都做了啥 如果
05/22 20:03, 52F
→
05/22 20:03, 5年前 , 53F
有 是不是就可以避免這種問題
05/22 20:03, 53F
→
05/22 20:04, 5年前 , 54F
壓根就沒review的話 code裡有甚麼奇怪東西 都是正常的
05/22 20:04, 54F
→
05/22 20:14, 5年前 , 55F
Google 自己提交的程式碼都良莠不齊了 算了吧
05/22 20:14, 55F
→
05/22 22:58, 5年前 , 56F
寫中文國外工程師看不懂 寫英文大家都看不懂 GG
05/22 22:58, 56F
推
05/22 23:52, 5年前 , 57F
為啥註解不能用i18n翻譯
05/22 23:52, 57F
推
05/23 00:45, 5年前 , 58F
中國廠商code一堆簡體字，還用GBK編碼不用unicode存@@
05/23 00:45, 58F
推
05/23 00:55, 5年前 , 59F
一堆人不知道文字編碼，最後亂存變亂碼
05/23 00:55, 59F
推
05/23 01:42, 5年前 , 60F
在外商 windows系統是全英文的 想寫中文也沒辦法xd
05/23 01:42, 60F
推
05/23 10:53, 5年前 , 61F
目前在3當lead，說一下我的想法，好的code不太需要註解，
05/23 10:53, 61F
→
05/23 10:53, 5年前 , 62F
註解只需要留真正核心的提示，那英文就足夠表達了
05/23 10:53, 62F
→
05/23 11:35, 5年前 , 63F
好的code要self-documented
05/23 11:35, 63F
推
05/23 12:17, 5年前 , 64F
核心提示是什麼？ 還是註解ＸＤ
05/23 12:17, 64F
推
05/23 18:34, 5年前 , 65F
還有同事用中文拼音來命名… 算權重的function他用chiuanChu
05/23 18:34, 65F
→
05/23 18:34, 5年前 , 66F
ng()
05/23 18:34, 66F
→
05/23 18:44, 5年前 , 67F
沒事兒 習慣26就好
05/23 18:44, 67F
推
05/24 13:05, 5年前 , 68F
拼音縮寫跟注音文一樣難懂
05/24 13:05, 68F
→
05/25 05:37, 5年前 , 69F
寫code的時候中文輸入法根本礙事
05/25 05:37, 69F
→
05/25 05:37, 5年前 , 70F
要用中文注釋的話效率感覺爆低
05/25 05:37, 70F
‣ 更多 tbpfs 的文章
文章代碼(AID): #1UnqHDoQ (Soft_Job)
Soft_Job 近期熱門文章
更多 近期熱門文章 >>
PTT職涯區 即時熱門文章
更多 即時熱門文章 >>
‣ 更多 tbpfs 的文章
文章代碼(AID): #1UnqHDoQ (Soft_Job)