作者tbpfs ( http://pse.is/tbpfs )
看板Soft_Job
标题[讨论] 关於中文注释的使用
时间Fri May 22 11:17:30 2020
有监於 上一篇文章
#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://webptt.com/cn.aspx?n=bbs/Soft_Job/M.1590117453.A.C9A.html
1F：推 cryinglove: 曾经听过某跨国企业，注解有日文韩文泰文中文英文，感 05/22 11:23
2F：→ cryinglove: 觉很容易崩溃的（人心崩溃 05/22 11:23
3F：推 abc0922001: 我只有在 commit message 的第三行後会用中文 05/22 11:42
4F：推 alihue: 这有什麽好讨论的，不久看会不会跟外国人合作决定就好 05/22 11:44
5F：嘘 pilor: 好的 05/22 12:02
6F：→ JasperChang: 如果异质母语合作人数少 当然请他们自己想办法 05/22 12:31
7F：→ JasperChang: 中文注释以前怕乱码而已 05/22 12:32
8F：推 Csongs: 跟中国同仁合作过，有人用汉语拼音当变数就是.. 05/22 12:50
9F：推 Csongs: 就看公司规定吧 规定英文就用英文 05/22 12:54
10F：→ godddddd: 我3 不介意中文 只介意产品上线没 05/22 13:40
11F：→ pttworld: 与其讨论中文，为什麽不讨论德国工程师用德文 05/22 14:08
12F：→ pttworld: team需要共通的语言就是英文，反之各国用各国的语言 05/22 14:09
13F：→ kvjo: 钛坦 放 顶级? 以我知道的 虽然开出很多号称200~300的缺 05/22 14:12
14F：→ kvjo: 但不少工程师 是100以内的 100以上 大多要 "配合call" 05/22 14:12
15F：→ kvjo: 而且 所谓的新加玻泰坦.... 除了博奕游戏外 有做别的吗? 05/22 14:13
16F：→ kvjo: 多数人在台湾做软体 应该只处於80-130之间 05/22 14:19
17F：→ kvjo: 台北资深一些 可以再上去一些 05/22 14:19
18F：推 luke72: 3,4才是最多用中文注释的 例如各种包案的开发商 05/22 14:34
19F：→ luke72: 有跟中国合作或者外包给中国的 简体字注释很常见 05/22 14:36
20F：推 wulouise: 我公司也是要求英文注解，原因是不能写太复杂 05/22 14:45
21F：推 NDark: 如果编译环境不行。那当然不行。 05/22 14:49
22F：→ NDark: 环境允许。那我可以接受英中并列/依需求补齐注解。 05/22 14:52
23F：→ NDark: 依需求就是 当有人看不懂的时候，就是时候安排时间写注解。 05/22 14:52
24F：→ NDark: 就跟文件的问题一样。永远都不可能写到满分。 05/22 14:53
25F：→ NDark: 但是无法写到满分并不构成不写注解的充分理由 05/22 14:53
26F：→ NDark: 以目前的资源该写多少，哪些先写。才是务实的做法。 05/22 14:54
27F：推 dong531: 4.没有要求，我的案子都写中文，注解是用来沟通的，能让 05/22 15:06
28F：→ dong531: 人快速了解程式就好 05/22 15:06
29F：推 asleisureto: 弄错顺序了吧，是进了顶级公司要用英文注释，而不是 05/22 15:17
30F：→ asleisureto: 用了英文注释就能进顶级公司 05/22 15:17
31F：推 NDark: 楼上有一种东西叫做舒适圈 05/22 15:23
32F：推 vi000246: //这行到底在冲三小 别逼我用blame 05/22 16:13
33F：推 king22649: 很好奇 用中文注释 是不是没有 code review 的文化？ 05/22 16:14
34F：→ xo1100: 顶级公司给出待遇待遇捏着LP遵守没问题啊 05/22 16:24
35F：→ xo1100: *顶级 05/22 16:26
36F：→ xo1100: 除非工作环境全部英文沟通不然到底有啥好嘴的 05/22 16:29
37F：→ devilkool: 笑了 干code review啥事 05/22 16:35
38F：推 oyaji5566: 注解也要支援多语系 05/22 16:38
39F：推 king22649: code review 文化啊～ 05/22 16:49
40F：→ Nonegrame: 很好奇 有 code review 是不是没有中文注解？ 05/22 17:02
41F：→ lazarus1121: 哼 我本来连变数都想取中文 05/22 17:22
42F：嘘 zexon97: 哪个大陆 05/22 17:35
43F：→ william81615: 当你要面对孤儿程式，上面还有一堆前人遗留的破英 05/22 18:19
44F：→ william81615: 文注解时，我认为写中文注解没什麽不好 05/22 18:19
45F：推 v7q4: visual studio范例程式的注解都有中文了 05/22 18:48
46F：推 sxy67230: 我都用中文写变数跟函数类别名称 05/22 19:10
47F：推 peanut97: 推29楼，因果关系清楚 05/22 19:32
48F：→ Csongs: code review 跟注解用什麽语言没关吧 05/22 19:37
49F：→ Csongs: 只能说用英文别人比较没什麽意见而已 05/22 19:37
50F：推 king22649: 个人是跟着google做 版上还有google code review m文 05/22 20:01
51F：→ king22649: 不用英文的原因大多是英文烂 不过我看google流程 也有 05/22 20:03
52F：→ king22649: review这项 所以很好奇 其他人review到底都做了啥 如果 05/22 20:03
53F：→ king22649: 有 是不是就可以避免这种问题 05/22 20:03
54F：→ king22649: 压根就没review的话 code里有甚麽奇怪东西 都是正常的 05/22 20:04
55F：→ JasperChang: Google 自己提交的程式码都良莠不齐了 算了吧 05/22 20:14
56F：→ Darkword1987: 写中文国外工程师看不懂 写英文大家都看不懂 GG 05/22 22:58
57F：推 azureroki: 为啥注解不能用i18n翻译 05/22 23:52
58F：推 tennyleaz: 中国厂商code一堆简体字，还用GBK编码不用unicode存@@ 05/23 00:45
59F：推 xvid: 一堆人不知道文字编码，最後乱存变乱码 05/23 00:55
60F：推 azzc1031: 在外商 windows系统是全英文的 想写中文也没办法xd 05/23 01:42
61F：推 Hitmear: 目前在3当lead，说一下我的想法，好的code不太需要注解， 05/23 10:53
62F：→ Hitmear: 注解只需要留真正核心的提示，那英文就足够表达了 05/23 10:53
63F：→ labbat: 好的code要self-documented 05/23 11:35
64F：推 NDark: 核心提示是什麽？ 还是注解ＸＤ 05/23 12:17
65F：推 v7q4: 还有同事用中文拼音来命名… 算权重的function他用chiuanChu 05/23 18:34
66F：→ v7q4: ng() 05/23 18:34
68F：推 wulouise: 拼音缩写跟注音文一样难懂 05/24 13:05
69F：→ watashino: 写code的时候中文输入法根本碍事 05/25 05:37
70F：→ watashino: 要用中文注释的话效率感觉爆低 05/25 05:37