[讨论] 关于中文注释的使用

楼主: 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