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

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

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

8556 次点击
所在节点    程序员
99 条回复
Solace202
2022-10-15 15:33:04 +08:00
注释都是中文,或者直接贴相关的需求链接地址。
日志一般打英文,不然要是中文乱码定位问题很难受
masterclock
2022-10-15 16:03:07 +08:00
编码问题没那么容易解决
尽管大多数情况下是 UTF8 ,可有的项目规定必须使用 GB2312 通信、文件编码必须是 GB18030
reallynyn
2022-10-15 16:12:05 +08:00
@si Utf8 还被巨硬搞出 bom 和 no-bom 呢。
记得很多年前 svn 提交中文会报错,我就习惯一直用英文写 comment 了。
ClarkAbe
2022-10-15 16:44:46 +08:00
一般中文, 除非一些国际上的才会拼几个单词上去, UTF-8 要是打开乱码然后还来辖几把问 "为什么打开乱码啊,怎么搞啊...", 那要么让他找个班上要么就.....
wolong
2022-10-15 17:09:23 +08:00
反正我写的是中文,要是写英文,我写的别人看不懂,别人写的我看不懂。
ilovecqrwx
2022-10-15 17:10:34 +08:00
在中国就写中文,这应该去解决乱码的问题呀
kiwi95
2022-10-15 17:23:09 +08:00
注释和 git log 一直都写英文,毕竟也代码是类似英文的。且不说编码问题,中文文本在结合一些 Linux 命令使用时不方便
JohnBull
2022-10-15 17:28:25 +08:00
只要确保使用 UTF-8 编码,我不拒绝中文注释
westoy
2022-10-15 17:44:09 +08:00
只要不写注释,就不会有这种烦恼
renmu
2022-10-15 17:52:23 +08:00
然后写翻译的英语是个二把刀,看翻译的也是个二把刀,语意不知道偏到哪里去了
lavenderkissyou
2022-10-15 18:24:30 +08:00
之前做单片机的时候,注释都是写的中文的,这样同事也看的方便一些
raptor
2022-10-15 19:11:46 +08:00
都这年头了,连乱码都处理不好的公司还是别混了吧……

当然如果是国际化团队的话,还是全英文好些。
fox0001
2022-10-15 19:16:27 +08:00
一般代码注释写中文。没办法,同事连 start 都不会读…

脚本、log 那些可能用英文,因为那些文件不能保证 utf-8 编码。
jorneyr
2022-10-15 19:23:16 +08:00
看一段我的代码:

/**
* 判断复制操作的结果是成功还是失败。
*
* 复制操作的输出样例:
* TASK [copy file or directory located at remote into Ansible Host] ************************************
* changed: [192.168.12.101]
*
* PLAY RECAP *******************************************************************************************
* 192.168.12.101 : ok=2 changed=1 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0
*
* 说明:
* - PLAY RECAP 的下一行表示操作成功失败的信息。
* - 使用 copy 模块从 Ansible 复制文件或者目录到 Node ,ok=2 时操作成功。
* - 使用 fetch 模块从 Node 复制文件到 Ansible ,ok=2 时操作成功。
* - 使用 fetch 模块从 Node 复制目录到 Ansible ,ok=3 时操作成功。
*
* @param copyOutput Ansible 复制操作的输出日志
* @return 复制操作成功则返回 true ,否则返回 false
*/
public static boolean judgeCopySuccess(String copyOutput) {
String ok = null;

Matcher matcher = COPY_RESULT_PATTERN.matcher(copyOutput);

if (matcher.find()) {
// 获取 ok 的值
ok = matcher.group(1);
}

return "2".equals(ok) || "3".equals(ok);
}
janxin
2022-10-15 19:30:37 +08:00
现在还有不按照 UTF-8 保存源文件的么...

以前确实是会有问题的,UTF-8 普及不够。
chenxiankong
2022-10-15 19:30:42 +08:00
注释的目的永远是给想看懂代码的人看懂。我的原则是:
- 如果都是公司内部人看,组员看,国人看,就中文。
- 如果是开源项目,还是英文比较好。
paopjian
2022-10-15 19:32:51 +08:00
中文会导致乱码问题确实可能存在啊,以前有人写 php,测试的时候服务器上有个小改动,vim 没设 utf-8 编码,导致打开再保存以后就有乱码串行了
limebax
2022-10-15 19:43:42 +08:00
偶尔会写吧,毕竟英文木有那么好
eason1874
2022-10-15 19:53:18 +08:00
写中文注释就行了,没有编辑器不支持 UTF8

如果部署环境不支持 UTF8 ,那在部署代码里添加自动删除注释的功能,自动清除注释再部署
MajestySolor
2022-10-15 20:02:20 +08:00
团队项目按团队规矩来,个人项目随便怎么折腾

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

https://www.v2ex.com/t/887092

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

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

© 2021 V2EX