V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
naijoag
V2EX  ›  职场话题

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

  •  
  •   naijoag · 2022-06-06 22:50:22 +08:00 · 7703 次点击
    这是一个创建于 626 天前的主题,其中的信息可能已经有所发展或是发生改变。

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

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

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

    大家怎么看

    第 1 条附言  ·  2022-06-08 00:24:15 +08:00
    我书面英文不差 我说了是练习英文:保持英文思维 我不需要学什么 再说没人指正 也学不到什么 只是说保持这种英文思维 google 的时候你没点书面英文能力 能快速精确搜索出内容吗
    优越感吧 我感觉确实有 我比较自卑 英文算是自己的强项 从小学到大学都是名列前茅的 毕业后在提高听说方面
    你自己喜欢的东西 在意的东西 被别人剥夺了 心理会没点感受吗 不知道为什么这么多喷我的
    102 条回复    2022-06-08 15:05:06 +08:00
    1  2  
    alanying
        1
    alanying  
       2022-06-06 22:52:02 +08:00
    团队大多数人喜欢中文,领导又偏向中文的话,用英文会很“突兀”
    naijoag
        2
    naijoag  
    OP
       2022-06-06 22:52:46 +08:00
    @alanying 领导写代码也是英文 项目负责人要求的我写中文
    sunwei0325
        3
    sunwei0325  
       2022-06-06 22:54:52 +08:00
    中文挺好的啊, 按规范写 commit, 用工具直接生成 changelog
    sagaxu
        4
    sagaxu  
       2022-06-06 22:55:00 +08:00
    @naijoag 让领导和项目负责人开会,他们定一个规范给你
    naijoag
        5
    naijoag  
    OP
       2022-06-06 22:56:00 +08:00
    @sagaxu 我倒希望我们有个规范 现在接口啥的都没规范哈哈
    naijoag
        6
    naijoag  
    OP
       2022-06-06 22:57:41 +08:00
    是的 要是有规范的话 我遵守没话说
    dcsuibian
        7
    dcsuibian  
       2022-06-06 23:11:59 +08:00   ❤️ 48
    如果 ①不是国际化开源项目 ②团队内部都是中国人 ( ③偏国内环境的业务 ),那这个要求正常的不能再正常了
    又不是变量或方法名用拼音,commit 信息和注释本身就是给人看的,那么中文应该是最佳选择了

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

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

    都不是的话在 commit 里写中文有啥问题??又没叫你用中文写代码
    timpaik
        17
    timpaik  
       2022-06-06 23:59:07 +08:00 via Android
    @Buges #13 早就能用中文输入法了。
    noyidoit
        18
    noyidoit  
       2022-06-07 00:09:27 +08:00
    @jessun1990 我试过,超 50 字不让写[doge]
    Buges
        19
    Buges  
       2022-06-07 00:15:10 +08:00 via Android
    @timpaik 并不能,我用了好久一直没发现不能输入中文,最近才发现不能用,然后搜到了老 k 的博客 https://www.csslayer.info/wordpress/fcitx-dev/chrome-state-of-input-method-on-wayland/
    Jooooooooo
        20
    Jooooooooo  
       2022-06-07 00:20:09 +08:00
    谁给你发工资谁说了算.
    Vegetable
        21
    Vegetable  
       2022-06-07 01:39:11 +08:00 via Android   ❤️ 15
    我见过很多人,硬是要写英文,关键是这玩意不仅书写有门槛,阅读也有门槛。
    最后写出来的英文中国人和外国人都看不懂。

    而且很多项目中,别说英文了,连中文术语都没统一,什么是订单什么是账单都有人理解错,还英文呢?

    我觉得纯中文的办公环境就应该用中文,很多变量枚举值也会考虑适当使用中文。代码写出来更多时候是用来看的,如果你发现某些地方用中文能更方便阅读,减少跳来跳去的次数,中文又有什么不好呢?
    salor
        22
    salor  
       2022-06-07 03:21:09 +08:00 via iPhone
    “你这种情况是要加钱的”
    dangyuluo
        23
    dangyuluo  
       2022-06-07 05:54:31 +08:00
    项目只有中国人参加的话写中文没什么问题,我们公司很多日本人还用日语写 commit message 呢,当然是他们组内部的 repo
    vagranth
        24
    vagranth  
       2022-06-07 08:11:54 +08:00
    这算什么要求?太扯了吧。这种要求让他发公开邮件说明。
    JaguarJack
        25
    JaguarJack  
       2022-06-07 08:20:36 +08:00 via iPhone
    @MrSheng 其实汉化之后反而看不懂了😂,还需要一段时间适应。
    chenyu0532
        26
    chenyu0532  
       2022-06-07 08:31:26 +08:00
    写中文任何人都看得懂,写英文你就不怕遇到个英文好的挑语法毛病么。。
    又不是上 guthub ,没必要
    satoru
        27
    satoru  
       2022-06-07 08:32:00 +08:00   ❤️ 2
    我想提交信息和注释跟其他写作没有太大区别,重要的是让读者能看明白。
    对方表示他看不懂,可能是他英文不好,但也可能是你“锻炼”中的英文表达不清楚,如果换成中文就能提升沟通效率何乐而不为。
    关于锻炼英文书面表达,我觉得跟各种刻意训练一样,反馈是很重要的,像你描述的场景我看不出有太有效的反馈,所以锻炼的效率也应该很低。
    jworg
        28
    jworg  
       2022-06-07 09:08:05 +08:00
    英文都看不懂的项目负责人能看懂代码吗,楼主心中有疙瘩的应该是这个地方,要是注释和代码不一致怎么办,这个所谓的项目负责人能 review 出来吗
    Goooooos
        29
    Goooooos  
       2022-06-07 09:08:23 +08:00
    你适合找个外企工作,不但写,日常交流也能锻炼
    wxsm
        30
    wxsm  
       2022-06-07 09:11:52 +08:00
    > 一个是自己喜欢英文 二来可以锻炼自己的英文书面表达 三来我感觉比写中文言简意赅

    这些都是你的主观看法,你喜欢英文,你想锻炼自己,你感觉英文比中文言简意赅。你站在一个开发者的角度思考了这个问题。那么换位思考一下,对于领导&整个团队来说,什么是更重要的呢?

    我觉得注释和提交信息清晰明了,大家可以一眼看懂,减少不必要沟通成本,减少可能因为英文不好而导致的误会,这可能更重要一些。
    youstu
        31
    youstu  
       2022-06-07 09:14:27 +08:00
    @Buges 我用 ubuntu 22.04 ,图形后端是 wayland ,chrome 上中文输入好好的
    Kaier
        32
    Kaier  
       2022-06-07 09:17:49 +08:00
    中英文都写不就得了~
    digimoon
        33
    digimoon  
       2022-06-07 09:25:10 +08:00   ❤️ 3
    你发的这个帖子为什么不是英文?
    littlewing
        34
    littlewing  
       2022-06-07 09:34:01 +08:00   ❤️ 1
    “为了他能看懂。。”
    是因为项目负责人不懂英语还是因为你写的英语别人看不懂,如果是前者,直接跑路
    murmur
        35
    murmur  
       2022-06-07 09:35:32 +08:00
    中国团队中国产品写英文的注释不奇怪么
    Vindroid
        36
    Vindroid  
       2022-06-07 09:39:17 +08:00
    自己英语水平有限,有些复杂的 bug 描述用英文不一定能表达清楚,所以我对于一两句话就能描述清楚的用英文,复杂的用中文
    dinghmcn
        37
    dinghmcn  
       2022-06-07 09:40:19 +08:00
    中国空间站都用中文了,对内的项目用中文不是很自然的选择吗?
    night98
        38
    night98  
       2022-06-07 09:50:55 +08:00
    你提的三条都是对你个人有利,注释写出来是团队协作,你是领导你怎么选?
    masterclock
        39
    masterclock  
       2022-06-07 09:50:57 +08:00
    全中国人团队吗?为什么要写英文?写中文感觉那啥了? low ?恶心?下贱?
    maddot
        40
    maddot  
       2022-06-07 09:54:58 +08:00
    对自己的英文这么自信?

    团队都是中国人并且也是国内的公司,要求中文才是正常的好么,写英文是你不正常

    我曾经在一个国内的要求写英文文档的团队,里面有博士,多数是研究生以上的,那英文写得真是让人不敢恭维,呵呵
    gzyguy
        41
    gzyguy  
       2022-06-07 09:56:16 +08:00
    不知道为啥要写英文,追求国际化?
    commit 信息不应该团队内人人秒读懂吗,愣是写英文不会是看老外项目看多了不自信了吧 [狗头]
    maddot
        42
    maddot  
       2022-06-07 09:59:23 +08:00   ❤️ 5
    在代码注释里锻炼自己的英文能力??这种想法理解不了接受不了
    BiChengfei
        43
    BiChengfei  
       2022-06-07 09:59:59 +08:00
    公司付钱给你,工作上的事,当然要服从公司规定
    sleepybear1113
        44
    sleepybear1113  
       2022-06-07 10:01:11 +08:00
    我写注释和 commit 都是中文的,为的就是能一眼看懂。写英文我自己还得翻译转一道,无故添加理解成本,有时候可能理解出错。而且有时候需要看啥时候写的那个功能的时候,中文一目了然。
    sunwei0325
        45
    sunwei0325  
       2022-06-07 10:02:05 +08:00   ❤️ 1
    fernandoxu
        46
    fernandoxu  
       2022-06-07 10:09:01 +08:00   ❤️ 2
    太逗了这帖子,纯国内公司国内团队,写英文的意义是啥?笑死人,有不是变量名函数名
    Haixiang
        47
    Haixiang  
       2022-06-07 10:18:25 +08:00
    不懂全员中国人里为什么要写英文 commit 。

    自己看过一些中式英文的 Commit 和注释,经常看到乱用时态、单复数、拼写错误、冠词不对、语法不通顺等等一堆问题。这些小毛病不会让人觉得你写英文很牛,只会觉得你不专业。

    如果要非要锻炼英文,自己去 Medium 写英文博客就可以了,要锻炼口语表达,自己录一个 YouTube 放一去被别人喷一喷都比写英文 commit 锻炼来得好。
    daliusu
        48
    daliusu  
       2022-06-07 10:28:55 +08:00
    不知道这有什么好纠结的,如果你的团队英文确实水平不太好,或者大家就想看中文,那你就用中文不就行了,你强行用英文别人也不一定看得懂也不一定看得舒服。如果你接受不了这件事情,早点离职对大家都好
    monkeylmj
        49
    monkeylmj  
       2022-06-07 10:32:07 +08:00
    国内团队中文 commit 没任何毛病,不会有理解上的毛病。 楼主不要因为自己的喜好,不接受团队的观点,自己不一定是对的
    cmdOptionKana
        50
    cmdOptionKana  
       2022-06-07 10:36:52 +08:00
    中国人写,给中国人看,为什么不用中文?这个道理怎么讲。
    zw1one
        51
    zw1one  
       2022-06-07 10:37:39 +08:00
    需团队达成共识,然后按规范来。
    neptuno
        52
    neptuno  
       2022-06-07 10:39:53 +08:00
    中国公司,全员中国程序员为啥不用中文写 commit 信息呀,很多人写的蹩脚英文,还带了很多自己定义的缩写,根本看不懂呀。
    ArthurMarcel
        53
    ArthurMarcel  
       2022-06-07 10:46:25 +08:00
    我觉得符合团队要求,中英文都可以,如果要求统一中文且没有开源国际化合作的场景下,听起来是非常合理的。另 好多人写蹩脚的英文注释不如不写......真的令人迷惑
    fox2081
        54
    fox2081  
       2022-06-07 10:51:17 +08:00
    你想着“迁就”着别人,有没有想过之前都是别人“迁就”着你
    cominghome
        55
    cominghome  
       2022-06-07 10:53:19 +08:00
    #7 说得很好,注释、日志都是给人看的,如果没有外籍人士能接触到这类信息,写中文未尝不可;我们部分系统也开始加中文日志了,因为部分告警会推送给非技术人员甚至一些基础岗位如客服,中文更便于大家理解
    guansixu
        56
    guansixu  
       2022-06-07 10:58:38 +08:00
    楼主写东西都不写标点符号的吗?
    lakehylia
        57
    lakehylia  
       2022-06-07 11:03:48 +08:00   ❤️ 3
    看来楼主的中文确实不好,通篇看下来就没几个中文符号。估计负责人会对你写的中文描述有意见的。
    NeezerGu
        58
    NeezerGu  
       2022-06-07 11:25:16 +08:00
    那我要是觉得想锻炼阿拉伯语呢……
    A555
        59
    A555  
       2022-06-07 11:26:22 +08:00
    需要写注释来锻炼英文能力,还是别写了吧
    xsldebugger
        60
    xsldebugger  
       2022-06-07 11:43:33 +08:00
    努力努力换外企吧,因为环境烂,还不允许你上进。以后你连外企都进不了
    xylxAdai
        61
    xylxAdai  
       2022-06-07 12:11:28 +08:00
    你给谁看的?只给中国人看的话注释和 commit 信息写中文没啥毛病。
    要不然你就换个公司。我觉得这个要求很合理,不是什么迁就的问题,你要明白,你写英文是别人在迁就你。
    potatowish
        62
    potatowish  
       2022-06-07 12:13:03 +08:00 via iPhone
    我很好奇那么多奇奇怪怪的需求,你怎么用英文写的,难道是拼音吗,没其他意思,就是单纯问问
    cxilife
        63
    cxilife  
       2022-06-07 12:20:13 +08:00
    想吐槽总是能找到槽点的,要是之前规定是英文,楼主今天个帖子标题可能是: 同事的英文水平不忍直视,XXXXXXXXXXXXXXXXXX 。
    timpaik
        64
    timpaik  
       2022-06-07 13:46:09 +08:00 via Android
    @Buges fctix 不清楚,我使用的是 GNOME + ibus-libpinyin ,没遇到啥兼容性问题
    Rrrrrr
        65
    Rrrrrr  
       2022-06-07 13:46:49 +08:00
    不要为反抗而反,注释这类东西还是写中文吧。
    Buges
        66
    Buges  
       2022-06-07 13:57:36 +08:00 via Android
    @timpaik gnome 好像实现了些 workaround ,kde 及其他各种 wm 都不行。
    OnionJuice
        67
    OnionJuice  
       2022-06-07 14:04:38 +08:00
    发布该主题的内容为什么不用英文?关于“一个是自己喜欢英文 二来可以锻炼自己的英文书面表达 三来我感觉比写中文言简意赅”,好像没什么说服力啊。
    vone
        68
    vone  
       2022-06-07 14:10:14 +08:00
    我直接不写 /doge
    HENQIGUAI
        69
    HENQIGUAI  
       2022-06-07 14:29:54 +08:00
    你在中国公司和中国人沟通,不写中文?我不理解。。。。
    fxxkgw
        70
    fxxkgw  
       2022-06-07 14:34:06 +08:00
    建议写文言文 更言简意赅
    elintwenty
        71
    elintwenty  
       2022-06-07 14:45:47 +08:00
    很多人英文写的都没法读,规范是为了让大家更好的沟通,除非你的项目很国际化或者大家英文水平都很好,否则用英文做注释或提交记录才是真正的影响大家工作效率,总有人以为用英文就是上进,那么英文不好的团队或非国际化大项目就赶快逃吧,这些不适合这样上进的人
    keepeye
        72
    keepeye  
       2022-06-07 14:49:20 +08:00
    英文言简意赅

    请用英文将这句话描述出来,让我看看有多么言简意赅
    ccyu220
        73
    ccyu220  
       2022-06-07 14:52:45 +08:00
    离大谱,看下来不知道是我有问题还是你有问题。
    loryyang
        74
    loryyang  
       2022-06-07 14:52:53 +08:00
    我们要求都写中文,因为大家英文水平有限
    然后换个问题:中文有什么不好?难道逼格太低?
    subpo
        75
    subpo  
       2022-06-07 14:59:21 +08:00
    以前买过,感觉还是不划算的,这玩意单独能占半平米地方
    没有的时候感觉总是要打印,买了之后反而就没有什么打印需求了。。
    3country
        76
    3country  
       2022-06-07 15:14:01 +08:00
    只写中文注释的路过。。。
    hoythan
        77
    hoythan  
       2022-06-07 15:19:40 +08:00
    你试试中英双拼?
    Fix: any...
    修复:某某某问题
    hoythan
        78
    hoythan  
       2022-06-07 15:21:27 +08:00
    @hoythan 不过英语水平不过关不要尝试,不然被人发现英文语法问题更尴尬。
    hhjswf
        79
    hhjswf  
       2022-06-07 15:29:14 +08:00
    woc ,你这是在工作啊,少在工作中整花活行吗,还美其名曰为他人着想。。。
    Ashore
        80
    Ashore  
       2022-06-07 15:42:47 +08:00
    写中文呗,起码大家都能看得懂 。不然后后面的人接手你的代码会很难受的
    andy2415
        81
    andy2415  
       2022-06-07 15:44:47 +08:00
    >一个是自己喜欢英文
    用英文发帖更能体现你的喜欢

    >二来可以锻炼自己的英文书面表达
    用英文发帖更能锻炼书面表达

    >三来我感觉比写中文言简意
    请将此贴翻译成英文, 我对比一下
    freefcw
        82
    freefcw  
       2022-06-07 15:44:54 +08:00
    语言是用来沟通的,如果英文能很好的沟通,那么无所谓,用中文写注释和提交日志又怎么样呢
    fpure
        83
    fpure  
       2022-06-07 15:48:58 +08:00
    @Vegetable 中国人和外国人都看不懂的英文太真实了😂
    xmt328
        84
    xmt328  
       2022-06-07 15:55:30 +08:00
    如果团队都是中国人,我觉得这样效率更高
    zjj19950716
        85
    zjj19950716  
       2022-06-07 16:00:38 +08:00
    @subpo 串台了?
    xingheng
        86
    xingheng  
       2022-06-07 16:04:47 +08:00
    我也一直写英文 commit message ,不论是自己的项目还是公司项目。如果公司项目没有 commit message template 的话,我觉得写英文 commit 是完全没有问题的。

    阅读理解方面,对自己,首先确认自己的表达是没有问题的,其次是解释清楚了当前 commit 的上下文和改动。对团队,能让别人理解是根本目的,没必要纠结语言问题,更不存在什么优越感。主流编程语言的文档就是英语,别人看不懂是别人的问题。我就没见过用中文搜索技术问题能直达 stack overflow 的,除了 chinese 频道。
    强行翻译有时候反而会造成误解,比如苹果 iOS 官方的类 UINavigationController 有人翻译成导航控制器,最开始看到的时候我反应了半天。有些业务名称在最初沟通的时候是用中文,还没有英文叫法,那我会写中文代替,理解为主。

    个人偏好:我很少在命令行写中文,因为我非常讨厌频繁切换输入法。我也“被建议”写中文 commit message ,迁就过,后来我没在那儿待很久。
    subpo
        87
    subpo  
       2022-06-07 16:07:38 +08:00
    @zjj19950716 #84 诶,我靠
    abctt
        88
    abctt  
       2022-06-07 16:43:14 +08:00
    蹩脚英文还是别了吧,时态乱用、介词乱用、语法还不对,那能叫英文吗。
    MiketsuSmasher
        89
    MiketsuSmasher  
       2022-06-07 16:51:37 +08:00
    中国人做的项目用英文写注释和提交信息,不管会不会写直接霸王硬上弓,自己都不觉得别扭吗?
    cxe2v
        90
    cxe2v  
       2022-06-07 16:54:09 +08:00   ❤️ 1
    这年头还有以因为用英语而产生优越感的,哎~
    Nowadays, there are people who have a sense of superiority because of using English. Aye~
    bigShrimp8577
        91
    bigShrimp8577  
       2022-06-07 18:04:22 +08:00
    你们 commit 写的都很专业,很标准的吗?我都是随便乱写些关键词的,毕竟还有字数限制,100 个字符,我想输入多点单词都没法子
    czfy
        92
    czfy  
       2022-06-07 18:10:45 +08:00
    If your content is meant to be read by someone, make it readable for them.
    SawyerGuo
        93
    SawyerGuo  
       2022-06-07 18:19:18 +08:00 via iPhone
    中国人的项目用中文写注释有何不可,还用英文写觉得言简意赅,真是搞笑,建议你出国,然后你就可以天天言简意赅了。
    ZHenJ
        94
    ZHenJ  
       2022-06-07 18:50:03 +08:00
    中英双语是不是解决了
    ALVC666
        95
    ALVC666  
       2022-06-07 18:56:16 +08:00
    中文就中文了
    我写英文纯粹是 ideavim 懒得切回中文。。。懒
    mmdnk
        96
    mmdnk  
       2022-06-07 21:01:05 +08:00
    这是发帖出来丢人的吗?
    liyaoxinchifan
        97
    liyaoxinchifan  
       2022-06-07 21:12:02 +08:00
    语言是沟通工具,应该用最高效的方式去用
    zhchyu999
        98
    zhchyu999  
       2022-06-07 22:13:56 +08:00
    你觉得用英文更高级么?
    Felix2Yu
        99
    Felix2Yu  
       2022-06-07 22:23:28 +08:00   ❤️ 1
    公司招你,是让你解决问题的,你的成果要让全体团队成员理解。而不是花钱请你来自学英语的
    kkzzkk
        100
    kkzzkk  
       2022-06-08 00:48:11 +08:00 via Android
    写英文注释没问题,但公司要求写中文其实也没问题,我想你觉得不爽的点在于领导要求写中文的理由是为了他自己能看懂吧?不用想那么多,都是打工的,拿钱办事就行了,目光要放长远,他也不会一辈子都是你领导
    1  2  
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   我们的愿景   ·   实用小工具   ·   942 人在线   最高记录 6543   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 34ms · UTC 22:09 · PVG 06:09 · LAX 14:09 · JFK 17:09
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.