[讨论] 注解 用中文还是英文

楼主: x246libra (楓)   2018-03-05 12:37:08
非本科 近了一家小公司 学着写程式
本身英文不好
英转中还可以看懂
中转英常常想不到用什么词
勉强靠GOOGLE用些简单的单字
让变量或函数 为有意义的命名
但是注解通常要写的比较详细
用英文总是思考很久,也不确定文法是否正确
想请问板上的其它人 注解是用中文还是英文写?
作者: ezaki (御坂小衣)   2018-03-05 12:51:00
以公司的人看得懂和交接方便说明为主
作者: pttworld (批踢踢世界)   2018-03-05 12:51:00
UTF-8的用中文我觉得可以
作者: robler (章鱼丸)   2018-03-05 12:52:00
你喜欢就好
作者: Boston (Boston)   2018-03-05 13:05:00
英文就算是 UTF-8 好了,但写个注解还要切输入法 不觉得麻烦吗
作者: alanturing (alan)   2018-03-05 13:06:00
注解是写给人看的 看的人能快速看懂才是重点
作者: robber1234 (超痛恨嘴炮)   2018-03-05 13:48:00
英文.除非你真的没法那就中文.中国人超爱写中文注解
作者: crossdunk (推嘘自如)   2018-03-05 13:50:00
我都写繁体中文,给你参考
作者: vi000246 (Vi)   2018-03-05 13:52:00
看是要给谁看的 要给外国人看就写英文
作者: simonjen (狂)   2018-03-05 13:57:00
我们公司有人直接用中文当变量,给你参考!
楼主: x246libra (楓)   2018-03-05 14:03:00
中文当变量 也太夸张XD
作者: keith222 (Keith)   2018-03-05 14:10:00
stackoverflow 上都有人用阿拉伯文变量问问题了
作者: cphe (魔鬼藏在垃圾筒里)   2018-03-05 14:16:00
注解就其他人看得懂最重要,文法不用太在意当然你如果文法错太夸张让人看不懂,可以考虑把英文学好
作者: hizuki (ayaka)   2018-03-05 14:24:00
水平好用英语,期待接手的人看不懂咯
作者: alihue (wanda wanda)   2018-03-05 15:12:00
如果都是一些中文专有名词,中文变量好用啊
作者: dsilver (细数远星永唱泉水)   2018-03-05 16:11:00
接手的人看不懂,你在公司才有价值(咦)
作者: PUTOUCHANG (自己的废文自己发)   2018-03-05 16:22:00
你可以用英文再加个 text 版的 doc 说明文件像 Linux kernel 的 Documentation 降
作者: leolarrel (真.粽子无双)   2018-03-05 16:31:00
推dsilver
作者: brianhsu (坟墓)   2018-03-05 16:38:00
如果公司的开发者母语都是中文,而且这个程式码也不需要给第三方,我会写中文。
作者: yyc1217 (somo)   2018-03-05 16:46:00
给谁看就用彼此共通的语言
作者: johnny94 (32767)   2018-03-05 17:00:00
编码没问题就用中文阿,注解就是要让人家看懂的。
作者: sunsamy   2018-03-05 17:28:00
程式码是最好的注解,若办不到代表程式水平很差,连命名都有困难,例如某作业系统的/dev/,/tmp/,fs,ls。然后再写注解:dev is device, tmp is temp, fs is file systemls is list。这就是脱裤子放屁了。真的好的注解是连这个区块,function在做什么都不用写,看式码,名子就略知一二
作者: peanut97 (丁丁)   2018-03-05 17:41:00
公司的人都讲中文,所以我都用中文
作者: coronach (...)   2018-03-05 18:25:00
自从多年前接手中国code被GB码炸过,我打死都不会写中文注解在code里如果你的注解用英文写不出来,那只有两个可能:1.你要写的东西复杂到应该写在文件里 2.你的英文程度烂到不该当工程师
作者: ku72 (ku72)   2018-03-05 18:40:00
中文习惯就写中文
作者: NCUking (中大王)   2018-03-05 18:59:00
拜托用中文写就好 英文不好还硬要写只是浪费队友时间
作者: sextitanic   2018-03-05 19:38:00
看你拿到的规格文件跟你同事的共通语言
作者: stfang925 (司马铃薯)   2018-03-05 19:42:00
只有拿到档案里有中文时才会打中文 其他全部英文
作者: kevin80112 (加油好嗎)   2018-03-05 20:52:00
连变量名称都要GOOGLE建议用中文
作者: descent (“雄辩是银,沉默是金”)   2018-03-05 21:00:00
我用英文是因为怕乱码, 其实我想用中文
作者: winddust (乔狼)   2018-03-05 21:02:00
程式中英文混杂,若是Linux下写shell,都用英文,主要是受默认编码这个变量影响,都要去try charset设定,用英文省事
作者: abccbaandy (敏)   2018-03-05 21:34:00
中文有时候真的找自己麻烦,尤其环境不能控制的时候
作者: LinuxKernel (Linus Torvalds)   2018-03-05 21:45:00
当然英文啊
作者: mathrew (Joey)   2018-03-05 22:21:00
英文 有时候会有编码问题
作者: dreamnook (亚龙)   2018-03-05 22:44:00
用拼音写注解(前同事遇过
作者: tw689 (台湾689)   2018-03-05 22:44:00
你英文好就英文,英文不好就中文 反正大多其实是给自己看的
作者: clamperni (肥宅牛牛)   2018-03-05 22:56:00
中文
作者: goths5958 (德克斯特)   2018-03-06 00:44:00
先想清楚注解是为了什么而写 就会知道要怎么选择
作者: eva19452002 (^^)   2018-03-06 06:28:00
dirty code才需要注解,clean code只需看variablename及function name就知道程式在做什么了当然还有个前提是每个function内聚力要够强
作者: cpper (韩立)   2018-03-06 07:25:00
说要写英文的人何不在ptt也写英文
作者: Vanses (Money~where r u )   2018-03-06 08:21:00
Definitely English. Unless you want your work can onlybe seen, checked and appreciated by Taiwanese and Chinese. Say you have a fancy work on Github which has description/inline comment written in Chinese. Only Chinese people will understand and appreciate it. You maytry writing the answer in Chinese on stackoverflow and see who will give you positive rating.
作者: nova06091   2018-03-06 08:29:00
A pen in my hole
作者: typepeter (∵Peter∴笑点)   2018-03-06 08:46:00
只限台湾人看的时候也许没差 但编码及维护性 英文较好
作者: nelley (名字:大便王)   2018-03-06 08:59:00
看交接给谁。。我中英日的都写过。。。然后,如果你是大神,你写台语都会有一堆人抢著看
作者: RadiationXen (Xen)   2018-03-06 09:06:00
团队有人母语不是中文,或不需要把原始码给第三方时,可以用中文。话说日本人也会用日文写注解
作者: qweqweqweqwe (4qwe)   2018-03-06 09:49:00
有机会交接的人看得懂最重要 语言是拿来沟通的
作者: vn509942 (如履薄冰)   2018-03-06 10:13:00
英文不好,拜托不要假掰注解是写给人看 不是写给鬼看
作者: b086232 (星间联络船)   2018-03-06 12:20:00
可以参阅我的程式码会说话,其中有个章节讲这个部分。
作者: akira01 (小吉)   2018-03-06 13:04:00
给台湾与大陆人用繁体中文,给洋人用英文
作者: darkMood (瞬间投射)   2018-03-06 13:06:00
外国你当然就写英文,台湾当然就写中文啊,你不知道多少工程师英文都烂到爆嘛............................
作者: kaitokid1214 (羽)   2018-03-06 13:26:00
注解就你看得懂,你一个月后看还是看得懂,你一年后看还是看得懂,别人N年后拿来问你还是看得懂,这样就好你要用摩斯密码写也OK
作者: NTULioner (LionsHeart)   2018-03-06 17:54:00
中文通常都额外写在wiki或文件上吧
作者: q26766 (cancan)   2018-03-06 19:35:00
不会英文不能当工程师是啥逻辑
作者: soi1dsnake (索立德史捏克)   2018-03-06 22:24:00
我都用法文 给你参考
作者: stosto (树多)   2018-03-06 23:34:00
注解顶多写fucking code....那个时候作者就会自己修掉了
作者: Ghamu (猫丸)   2018-03-06 23:57:00
英文太烂 一句话不知道要有主词 动词 时态正确者 乖乖写中文吧我是偏好写英文 程式码是英文 注解也是英文 你的大脑会少一层context switch 拖慢 而英文真的太差者 一般也难写出可读的程式码之前看到有个func 叫做 go() 想说是要go to where? 喔 原来是start()的意思啊 干你娘
作者: Ayukawayen (亚布里艾尔发芽>//<)   2018-03-07 00:12:00
可能有另一个function叫ready()
作者: luckyluck (肚脐)   2018-03-07 00:44:00
写德文
作者: CHICHINGTSAI (CC)   2018-03-07 08:05:00
可能英文比较好喔!避免乱码搞死后面接手的人还是同事
作者: markbex (马克杯)   2018-03-07 10:37:00
同事和环境都中文就写中文 要看英文就直接看code就好
作者: Csongs (西歌)   2018-03-07 12:58:00
与其让下面写些奇怪英文注解 不如用中文乱码问题统一用utf8就好上面 go start我笑了XDD
作者: RumiManiac (Rumi!)   2018-03-07 13:06:00
go XDDDDDDD
作者: kenwufederer (Nash)   2018-03-07 15:22:00
看环境,不需要一定要用英文,让人头痛而已
作者: accessdenied (存取违规)   2018-03-07 17:22:00
不是所有的编译器都认识UTF8, 用英文比较好。而且用go我觉得也没什么问题,很好理解。是阅读人英文不好,把go和goto搞混。“去!”很直觉啊
作者: Ghamu (猫丸)   2018-03-08 02:54:00
想想英文或许也不用很好 应该说同一水平就好 都用台式英文也可沟通无障碍 不过我真的十分难理解明明官方api 范例程式码 setup update put get 等等一堆寻常关键字眼不用 偏爱自己造新词的家伙在想什么 我一直尽量想让东西一致 可依循每次稍微畸形点到命名都在心里忏悔 [干...原谅我] 但好像有满多人是跟着感觉走的 以自己为中心的觉得go 好的 请用go 造一个句子表示启动一个task. 我用start. start a task 好了那 go呢?
作者: PUTOUCHANG (自己的废文自己发)   2018-03-08 03:25:00
go(); segfault at xxx rip xxx rsp xxx error 6
作者: dapple (dapple)   2018-03-08 10:00:00
写在code里面的东西都用英文 不要写中文之前就遇过注释写中文结果build break的事件
作者: robber1234 (超痛恨嘴炮)   2018-03-08 15:43:00
这么多人赞成不需用英文,看得我心里发寒大学甚至硕士毕业的高材生 英文写不好还找理由吗
作者: hegemon (hegemon)   2018-03-08 20:09:00
全部用英文呀,同事中文不好怎么办?
作者: littleyuan (baby)   2018-03-09 05:40:00
我自己是移民北美十几年在全英环境科技公司工作 如果看到有人写go也能理解 只是go比较有不同意思 start或许更直观些
作者: Csongs (西歌)   2018-03-09 08:12:00
当你同事英文烂就知道了,review code大陆同仁还用汉语拼音参杂,整个昏倒
作者: johnson0403 (菜鸟上班族)   2018-03-09 19:23:00
看公司...还有区域 像我们在越南就注解要英越文了...
作者: lturtsamuel (港都都教授)   2018-03-14 16:40:00
看到有人写个中文就发寒 我也心里发寒
作者: bizer (bizer)   2018-03-26 01:02:00
不是所有compiler都吃中文,但英文是绝对可吃,遇过debug怎么找都找不到问题的,结果是注释不小心打了一个中文字

Links booklink

Contact Us: admin [ a t ] ucptt.com