大家的代码注释有写中文的吗?

2022-10-15 12:06:01 +08:00
 yhm2046

昨天公司内部培训代码规范,我提出中文注释会导致乱码问题, cto 直接说以后不能用中文和拼音全部用英文, ceo 说第一次听到有人注释用中文. 我的疑问 1.是否所有大公司都不允许注释用英文和拼音? 2.如果全部用英文那英文水平一般的怎么根据关键字查找代码,比如我第一次写的英文单词跟后面不一样或者忘了查起来比较麻烦,类似 git log 这种用中文也比较直观,这也是我一直用中文的原因.

9383 次点击
所在节点    程序员
99 条回复
majula
2022-10-16 02:03:01 +08:00
注释写不写中文,跟文档写不写中文,原则是一样的

如果目标用户和协作者只有国人,比如公司项目、面向国人的开源项目等,那就用中文,否则用英文

除非团队另有规范
suyeH
2022-10-16 04:07:25 +08:00
从来不写中文,代码里面夹着中文,看着就不舒服
billgong
2022-10-16 05:56:01 +08:00
@chenshun00 同意啊,都 2020+了难不成还有代码不是 Unicode 保存的?
akira
2022-10-16 06:22:03 +08:00
每家公司的实际情况都不大一样,按照定好的规范要求走就是了。

小马过河 不只是一篇课文。
iwh718
2022-10-16 08:13:24 +08:00
注释也卷吗。
wangritian
2022-10-16 09:40:55 +08:00
全中国人的团队注释写英文你不感觉搞笑吗
FrankHB
2022-10-16 09:46:57 +08:00
@GeruzoniAnsasu 不说中文,倒也可能是负责给 Unicode 糊的屎擦屁股的公司。
比如纠结标识符里能给用哪些 emoji 。
FrankHB
2022-10-16 10:02:30 +08:00
@FrankFang128 @kingcc @interim 这问题不是改过了?我这里看到的是 OP 说“我提出中文注释会导致乱码问题”,CTO 直接拒绝中文和拼音,也没说理由跟乱码有关(拒绝拼音跟乱码应该也没关系)。

@IvanLi127 这边对未经许可擅自加 emoji 的我会认真基于头脑过于简单的理由考虑打死,至少有这些理由:
(1)可能毫无原则地歧视色觉障碍者;
(2)直接就有 www.open-std.org/jtc1/sc22/wg21/docs/papers/2021/p1949r7.html#all-emoji-become-excluded-instead-of-just-some 这样的 zz 不正确的破事;
(3)可能间接扰乱关注点,唆使业界一般用户普遍分不清重点,导致或者加剧 github.com/llvm/llvm-project/issues/54732 之类的问题。

@reallynyn 你太抬举巨硬了。
BOM 不是巨硬发明的,正如一般的二进制文件的文件头也不是巨硬发明的一样。

没 BOM 而产生混乱的实例是很好找,比如 VS 就不认没 BOM 的 UTF-8 。FreeImage 这种注释里直接写了非 ASCII 作者名字的在当前代码页中不认识,一打开就就呵呵了。
但对没 BOM 的“文件”的处理本来就是君子协定。说到底代码页也不是巨硬发明的。
neptuno
2022-10-16 10:06:10 +08:00
中国公司就写中文,有些同事写的那个蹩脚英文。。。还不如中文
MEIerer
2022-10-16 10:06:52 +08:00
同事只会英文,那就写英文,是国人,那就中文咯
tohuer00
2022-10-16 11:19:57 +08:00
除非你们团队都是能英文无障碍交流的水平,不然就是舍本逐末了。

中文因为误操作变成了乱码还能从版本控制工具里面找回历史记录,看不懂的蹩脚英文就真的永远没人能看懂了。
dog82
2022-10-16 11:50:26 +08:00
不明白中文注释为什么会乱码,好像锟斤拷这三个字好久没遇到了。

如果在外企,遵守人家的规范。国内企业不让写中文就装 B 过头了
cy18
2022-10-16 23:47:16 +08:00
编码问题不止 IDE 跟编辑器,你试试在 bash 里面 git log ,git diff 一下?
注释用中文,那变量、函数名用英文单词还是拼音?如果用拼音的,当我没说;如果用英文单词,有时候注释里的中文跟变量、函数名的不太好准确对应起来,反而看着难受。而且用英文注释用习惯了,更容易起好变量、函数名。
Bingchunmoli
2022-10-17 01:57:46 +08:00
没写过英文,因为英文需要我写中文然后百度翻译,质量不如不懈
MrSheng
2022-10-17 10:05:40 +08:00
不明白为何中文会导致乱码,建议你司先解决编码问题。

那些 使用不支持中文编码的终端的、直接在服务器上调试代码的 “大神” 应该拉出去打死。
yuruizhe
2022-10-17 13:04:28 +08:00
@shijingshijing 为啥会这样…注释还会影响代码的执行?不会注释里有代码、然后直接 exec 字符串吧…
yuruizhe
2022-10-17 13:05:55 +08:00
@star9029 啥编译器啊这么垃圾…文本预处理都做不了…报个名字给大伙避避坑吧
shijingshijing
2022-10-17 13:52:34 +08:00
@yuruizhe 那个测试工具可以用 VBS 和 Py 两种脚本,反正都不支持中文,可能是自己造了某种预编译的轮子吧,或者还有其他自动检查工具,反正是过不了,直接退出。
unco020511
2022-10-17 15:36:59 +08:00
原则:注释要团队内大部分人能看懂. 反正我们团队是中文注释

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://tanronggui.xyz/t/887092

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX