commit 信息和代码注释要求写中文

2022-06-06 22:50:22 +08:00
 naijoag

起因是 我开发的一个版本中出现了一个稍微大点的 bug 数据未根据用户做隔离 b 端系统 自己内部使用

后面领导要求提 mr 给项目负责人 review 然后项目负责人要求我 commit 信息和代码里面的注释都要写中文。为了他能看懂。。

从业以来 commit 信息一直写的英文 一个是自己喜欢英文 二来可以锻炼自己的英文书面表达 三来我感觉比写中文言简意赅 当时也没反驳 想着迁就下算了 为了他人着想嘛 但又感觉有点那啥

大家怎么看

7888 次点击
所在节点    职场话题
102 条回复
alanying
2022-06-06 22:52:02 +08:00
团队大多数人喜欢中文,领导又偏向中文的话,用英文会很“突兀”
naijoag
2022-06-06 22:52:46 +08:00
@alanying 领导写代码也是英文 项目负责人要求的我写中文
sunwei0325
2022-06-06 22:54:52 +08:00
中文挺好的啊, 按规范写 commit, 用工具直接生成 changelog
sagaxu
2022-06-06 22:55:00 +08:00
@naijoag 让领导和项目负责人开会,他们定一个规范给你
naijoag
2022-06-06 22:56:00 +08:00
@sagaxu 我倒希望我们有个规范 现在接口啥的都没规范哈哈
naijoag
2022-06-06 22:57:41 +08:00
是的 要是有规范的话 我遵守没话说
dcsuibian
2022-06-06 23:11:59 +08:00
如果 ①不是国际化开源项目 ②团队内部都是中国人 ( ③偏国内环境的业务 ),那这个要求正常的不能再正常了
又不是变量或方法名用拼音,commit 信息和注释本身就是给人看的,那么中文应该是最佳选择了

你提的三个因素,前两个跟公司没有关系,第三个也是你的个人看法
jessun1990
2022-06-06 23:20:29 +08:00
在这种情况下,中英文都写上,绝对不会有错。
JCZ2MkKb5S8ZX9pq
2022-06-06 23:21:40 +08:00
没啥好纠结的,既然还在练书面表达的阶段,那英文水平很可能还会进步变化吧,没准过几个月看自己写的英文都觉得别扭或者用词不准表意不清呢。
项目还是要从长计议的,还是要考虑后续接手项目的人。

@sunwei0325 commit 生成 changelog 有啥工具推荐嘛,听着有点意思。
villivateur
2022-06-06 23:24:21 +08:00
写中文没有任何问题,注释是给人看的,除非你去当负责人
ttgo
2022-06-06 23:31:39 +08:00
不能忍,必须润。
naijoag
2022-06-06 23:35:59 +08:00
算了 就抱怨下吧 也没啥意义 迁就下吧为了让接手的人能看得懂 下次遇见这样 直接叫制定规范吧 没规范不改[doge]
Buges
2022-06-06 23:46:44 +08:00
你可以换 Linux ,现在包括 vscode 在内的所有 electron 应用和 chromium 在 wayland 下还不支持中文输入法,这样就有借口只写英文了。
lzgshsj
2022-06-06 23:47:58 +08:00
怎么说呢,首先看团队规范,如果没有规范的话,有些人写英文有些人写中文,会显得比较乱。最好协商好要么全中文,要么全英文。
MrSheng
2022-06-06 23:51:13 +08:00
一直用中文,并且 IDE 也是汉化版本。
来吧,秀优越的可以开喷了。
wunonglin
2022-06-06 23:52:42 +08:00
是开源代码吗?
是有海外人员参与吗?

都不是的话在 commit 里写中文有啥问题??又没叫你用中文写代码
timpaik
2022-06-06 23:59:07 +08:00
@Buges #13 早就能用中文输入法了。
noyidoit
2022-06-07 00:09:27 +08:00
@jessun1990 我试过,超 50 字不让写[doge]
Buges
2022-06-07 00:15:10 +08:00
@timpaik 并不能,我用了好久一直没发现不能输入中文,最近才发现不能用,然后搜到了老 k 的博客 https://www.csslayer.info/wordpress/fcitx-dev/chrome-state-of-input-method-on-wayland/
Jooooooooo
2022-06-07 00:20:09 +08:00
谁给你发工资谁说了算.

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

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

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

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

© 2021 V2EX