作者x246libra (宸火)
看板Soft_Job
标题[讨论] 注解 用中文还是英文
时间Mon Mar 5 12:37:08 2018
非本科 近了一家小公司 学着写程式
本身英文不好
英转中还可以看懂
中转英常常想不到用什麽词
勉强靠GOOGLE用些简单的单字
让变数或函数 为有意义的命名
但是注解通常要写的比较详细
用英文总是思考很久,也不确定文法是否正确
想请问板上的其它人 注解是用中文还是英文写?
--
※ 发信站: 批踢踢实业坊(ptt.cc), 来自: 61.220.35.157
※ 文章网址: https://webptt.com/cn.aspx?n=bbs/Soft_Job/M.1520224631.A.6F4.html
1F：→ ezaki: 以公司的人看得懂和交接方便说明为主 03/05 12:51
2F：→ pttworld: UTF-8的用中文我觉得可以 03/05 12:51
3F：→ robler: 你喜欢就好 03/05 12:52
4F：推 Boston: 英文 03/05 13:05
5F：→ Boston: 就算是 UTF-8 好了，但写个注解还要切输入法 不觉得麻烦吗 03/05 13:05
6F：→ alanturing: 注解是写给人看的 看的人能快速看懂才是重点 03/05 13:06
7F：→ robber1234: 英文.除非你真的没法那就中文.中国人超爱写中文注解 03/05 13:48
8F：→ crossdunk: 我都写繁体中文，给你参考 03/05 13:50
9F：→ vi000246: 看是要给谁看的 要给外国人看就写英文 03/05 13:52
10F：→ simonjen: 我们公司有人直接用中文当变数，给你参考！ 03/05 13:57
11F：→ x246libra: 中文当变数 也太夸张XD 03/05 14:03
12F：推 keith222: stackoverflow 上都有人用阿拉伯文变数问问题了 03/05 14:10
13F：→ cphe: 注解就其他人看得懂最重要，文法不用太在意 03/05 14:16
14F：→ cphe: 当然你如果文法错太夸张让人看不懂，可以考虑把英文学好 03/05 14:17
15F：→ hizuki: 水平好用英语，期待接手的人看不懂咯 03/05 14:24
16F：推 alihue: 如果都是一些中文专有名词，中文变数好用啊 03/05 15:12
17F：推 dsilver: 接手的人看不懂，你在公司才有价值(咦) 03/05 16:11
18F：→ PUTOUCHANG: 你可以用英文再加个 text 版的 doc 说明文件 03/05 16:22
19F：→ PUTOUCHANG: 像 Linux kernel 的 Documentation 降 03/05 16:23
20F：推 leolarrel: 推dsilver 03/05 16:31
21F：推 brianhsu: 如果公司的开发者母语都是中文，而且这个程式码也不需 03/05 16:38
22F：→ brianhsu: 要给第三方，我会写中文。 03/05 16:39
23F：→ yyc1217: 给谁看就用彼此共通的语言 03/05 16:46
24F：推 johnny94: 编码没问题就用中文阿，注解就是要让人家看懂的。 03/05 17:00
25F：推 sunsamy: 程式码是最好的注解,若办不到代表程式水平很差,连命名都 03/05 17:28
26F：→ sunsamy: 有困难,例如某作业系统的/dev/,/tmp/,fs,ls。然後再写注 03/05 17:28
27F：→ sunsamy: 解：dev is device, tmp is temp, fs is file system 03/05 17:28
28F：→ sunsamy: ls is list。这就是脱裤子放屁了。真的好的注解是连这个 03/05 17:28
29F：→ sunsamy: 区块,function在做什麽都不用写,看式码,名子就略知一二 03/05 17:29
30F：推 peanut97: 公司的人都讲中文，所以我都用中文 03/05 17:41
31F：推 coronach: 自从多年前接手中国code被GB码炸过，我打死都不会写中文 03/05 18:25
32F：→ coronach: 注解在code里 03/05 18:25
33F：→ coronach: 如果你的注解用英文写不出来，那只有两个可能：1.你要写 03/05 18:28
34F：→ coronach: 的东西复杂到应该写在文件里 2.你的英文程度烂到不该当 03/05 18:28
35F：→ coronach: 工程师 03/05 18:28
36F：→ ku72: 中文习惯就写中文 03/05 18:40
37F：推 NCUking: 拜托用中文写就好 英文不好还硬要写只是浪费队友时间 03/05 18:59
38F：→ sextitanic: 看你拿到的规格文件跟你同事的共通语言 03/05 19:38
39F：推 stfang925: 只有拿到档案里有中文时才会打中文 其他全部英文 03/05 19:42
40F：推 kevin80112: 连变数名称都要GOOGLE建议用中文 03/05 20:52
41F：→ descent: 我用英文是因为怕乱码, 其实我想用中文 03/05 21:00
42F：推 winddust: 程式中英文混杂，若是Linux下写shell，都用英文，主要是 03/05 21:02
43F：→ winddust: 受预设编码这个变数影响，都要去try charset设定，用英 03/05 21:02
44F：→ winddust: 文省事 03/05 21:02
45F：推 abccbaandy: 中文有时候真的找自己麻烦，尤其环境不能控制的时候 03/05 21:34
46F：推 LinuxKernel: 当然英文啊 03/05 21:45
47F：推 mathrew: 英文 有时候会有编码问题 03/05 22:21
48F：→ dreamnook: 用拼音写注解(前同事遇过 03/05 22:44
49F：推 tw689: 你英文好就英文，英文不好就中文 反正大多其实是给自己看的 03/05 22:44
50F：→ clamperni: 中文 03/05 22:56
51F：推 goths5958: 先想清楚注解是为了什麽而写 就会知道要怎麽选择 03/06 00:44
52F：→ eva19452002: dirty code才需要注解，clean code只需看variable 03/06 06:28
53F：→ eva19452002: name及function name就知道程式在做什麽了 03/06 06:28
54F：→ eva19452002: 当然还有个前提是每个function内聚力要够强 03/06 06:31
55F：推 cpper: 说要写英文的人何不在ptt也写英文 03/06 07:25
56F：推 Vanses: Definitely English. Unless you want your work can only 03/06 08:21
57F：→ Vanses: be seen, checked and appreciated by Taiwanese and Chi 03/06 08:21
58F：→ Vanses: nese. Say you have a fancy work on Github which has d 03/06 08:21
59F：→ Vanses: escription/inline comment written in Chinese. Only Chi 03/06 08:21
60F：→ Vanses: nese people will understand and appreciate it. You may 03/06 08:21
61F：→ Vanses: try writing the answer in Chinese on stackoverflow an 03/06 08:21
62F：→ Vanses: d see who will give you positive rating. 03/06 08:21
63F：推 nova06091: A pen in my hole 03/06 08:29
64F：推 typepeter: 只限台湾人看的时候也许没差 但编码及维护性 英文较好 03/06 08:46
65F：推 nelley: 看交接给谁。。我中英日的都写过。。。然後，如果你是大 03/06 08:59
66F：→ nelley: 神，你写台语都会有一堆人抢着看 03/06 08:59
67F：推 RadiationXen: 团队有人母语不是中文，或不需要把原始码给第三方 03/06 09:06
68F：→ RadiationXen: 时，可以用中文。话说日本人也会用日文写注解 03/06 09:06
69F：→ qweqweqweqwe: 有机会交接的人看得懂最重要 语言是拿来沟通的 03/06 09:49
70F：推 vn509942: 英文不好，拜托不要假掰 03/06 10:13
71F：→ vn509942: 注解是写给人看 不是写给鬼看 03/06 10:14
72F：推 b086232: 可以参阅我的程式码会说话，其中有个章节讲这个部分。 03/06 12:20
73F：推 akira01: 给台湾与大陆人用繁体中文，给洋人用英文 03/06 13:04
74F：嘘 darkMood: 外国你当然就写英文，台湾当然就写中文啊，你不知道多少 03/06 13:06
75F：→ darkMood: 工程师英文都烂到爆嘛............................ 03/06 13:06
76F：推 kaitokid1214: 注解就你看得懂,你一个月後看还是看得懂,你一年後看 03/06 13:26
77F：→ kaitokid1214: 还是看得懂,别人N年後拿来问你还是看得懂,这样就好 03/06 13:26
78F：→ kaitokid1214: 你要用摩斯密码写也OK 03/06 13:26
79F：→ NTULioner: 中文通常都额外写在wiki或文件上吧 03/06 17:54
80F：推 q26766: 不会英文不能当工程师是啥逻辑 03/06 19:35
81F：→ soi1dsnake: 我都用法文 给你参考 03/06 22:24
82F：推 stosto: 注解顶多写fucking code....那个时候作者就会自己修掉了 03/06 23:34
83F：推 Ghamu: 英文太烂 一句话不知道要有主词 动词 时态正确者 乖乖写中 03/06 23:57
84F：→ Ghamu: 文吧 03/06 23:57
85F：→ Ghamu: 我是偏好写英文 程式码是英文 注解也是英文 你的大脑会少一 03/06 23:59
86F：→ Ghamu: 层context switch 拖慢 而英文真的太差者 一般也难写出可读 03/06 23:59
87F：→ Ghamu: 的程式码 03/06 23:59
88F：→ Ghamu: 之前看到有个func 叫做 go() 想说是要go to where? 喔 原来 03/07 00:01
89F：→ Ghamu: 是start()的意思啊 干你娘 03/07 00:01
90F：推 Ayukawayen: 可能有另一个function叫ready() 03/07 00:12
91F：推 luckyluck: 写德文 03/07 00:44
92F：推 CHICHINGTSAI: 可能英文比较好喔！避免乱码搞死後面接手的人还是同 03/07 08:05
93F：→ CHICHINGTSAI: 事 03/07 08:05
94F：推 markbex: 同事和环境都中文就写中文 要看英文就直接看code就好 03/07 10:37
95F：推 Csongs: 与其让下面写些奇怪英文注解 不如用中文 03/07 12:58
96F：→ Csongs: 乱码问题统一用utf8就好 03/07 12:59
97F：→ Csongs: 上面 go start我笑了XDD 03/07 13:00
98F：→ RumiManiac: go XDDDDDDD 03/07 13:06
99F：→ kenwufederer: 看环境，不需要一定要用英文，让人头痛而已 03/07 15:22
100F：推 accessdenied: 不是所有的编译器都认识UTF8, 用英文比较好。而且 03/07 17:22
101F：→ accessdenied: 用go我觉得也没什麽问题，很好理解。是阅读人英文 03/07 17:22
102F：→ accessdenied: 不好，把go和goto搞混。「去！」很直觉啊 03/07 17:22
103F：推 Ghamu: 想想英文或许也不用很好 应该说同一水平就好 都用台式英文 03/08 02:54
104F：→ Ghamu: 也可沟通无障碍 不过我真的十分难理解明明官方api 范例程 03/08 02:54
105F：→ Ghamu: 式码 setup update put get 等等一堆寻常关键字眼不用 偏爱 03/08 02:54
106F：→ Ghamu: 自己造新词的家伙在想什麽 我一直尽量想让东西一致 可依循 03/08 02:54
107F：→ Ghamu: 每次稍微畸形点到命名都在心里忏悔 [干...原谅我] 但好像 03/08 02:54
108F：→ Ghamu: 有满多人是跟着感觉走的 以自己为中心的 03/08 02:54
109F：→ Ghamu: 觉得go 好的 请用go 造一个句子表示启动一个task. 我用star 03/08 03:07
110F：→ Ghamu: t. start a task 好了那 go呢？ 03/08 03:07
111F：→ PUTOUCHANG: go(); segfault at xxx rip xxx rsp xxx error 6 03/08 03:25
112F：推 dapple: 写在code里面的东西都用英文 不要写中文 03/08 10:00
113F：→ dapple: 之前就遇过注释写中文结果build break的事件 03/08 10:01
114F：→ robber1234: 这麽多人赞成不需用英文，看得我心里发寒 03/08 15:43
115F：→ robber1234: 大学甚至硕士毕业的高材生 英文写不好还找理由吗 03/08 15:44
116F：推 hegemon: 全部用英文呀，同事中文不好怎麽办? 03/08 20:09
117F：推 littleyuan: 我自己是移民北美十几年在全英环境科技公司工作 如果 03/09 05:40
118F：→ littleyuan: 看到有人写go也能理解 只是go比较有不同意思 start或 03/09 05:40
119F：→ littleyuan: 许更直观些 03/09 05:40
120F：推 Csongs: 当你同事英文烂就知道了，review code大陆同仁还用汉语拼 03/09 08:12
121F：→ Csongs: 音参杂，整个昏倒 03/09 08:12
122F：→ johnson0403: 看公司...还有区域 像我们在越南就注解要英越文了... 03/09 19:23
123F：推 lturtsamuel: 看到有人写个中文就发寒 我也心里发寒 03/14 16:40
124F：推 bizer: 不是所有compiler都吃中文，但英文是绝对可吃，遇过debug怎 03/26 01:02
125F：→ bizer: 麽找都找不到问题的，结果是注释不小心打了一个中文字 03/26 01:02