mec
V2EX  ›  问与答

大家注释用中文还是英文

  •  
  •   mec · Mar 24, 2017 · 13347 views
    This topic created in 3514 days ago, the information mentioned may be changed or developed.

    自己写代码有注释的习惯,感觉用中文每次 review 会更快进入状态。那么,如何看待在业务代码中用英文注释的行为捏(非开源项目),大家都怎么注释

    59 replies  •  2017-03-26 00:52:51 +08:00
    xiaoz
    xiaoz
    Mar 24, 2017❤️4
    1
    英文不好,我就不装逼了,一般都是打中文。
    Rice
    Rice
    Mar 24, 2017
    2
    不写
    Mogugugugu
    Mogugugugu
    Mar 24, 2017
    3
    这个主要取决于给谁看...
    x86
    x86
    Mar 24, 2017 via iPhone❤️4
    4
    拼音
    UnisandK
    UnisandK
    Mar 24, 2017
    5
    给自己看的一般还是打中文,要是自己看着还得理解一下才能懂就失去注释的意义了
    zuosiruan
    zuosiruan
    Mar 24, 2017 via Android
    6
    @x86 哈哈(ಡωಡ)hiahiahia
    ys0290
    ys0290
    Mar 24, 2017 via iPhone
    7
    拼音
    asen1987
    asen1987
    Mar 24, 2017
    8
    中文。。主要都是给自己看和面向国人嘛。
    而且一堆英文代码里面,中文注释多醒目易找...
    coderluan
    coderluan
    Mar 24, 2017
    9
    取决于给谁看+1
    只是自己的项目,我倾向于:
    不写注释,分好函数和模块,然后用名称体现功能。
    Mutoo
    Mutoo
    Mar 24, 2017
    10
    之前看了本小书,从日文译来的。书上的源码链接不能用了,就在网上找到了官方源码,注释全是日语,当时就崩溃。
    peesefoo
    peesefoo
    Mar 24, 2017 via Android
    11
    英文比格高
    jmc891205
    jmc891205
    Mar 24, 2017
    12
    在公司写英文 因为团队里有好多老外
    在家里也写英文 因为不高兴写注释的时候还要切换中英文
    viator42
    viator42
    Mar 24, 2017
    13
    尝试过用英文写注释,后来发现注释的可读性还没有代码高
    Ncanback
    Ncanback
    Mar 24, 2017
    14
    看项目给谁喽
    1.给非 IT 企业 /不需要技术的 中文,而且尽可能详细
    2.业内项目 纯英文
    3.自己写的玩的 不写注释 自己写的都看不懂那就真完蛋了....
    U7Q5tLAex2FI0o0g
    U7Q5tLAex2FI0o0g
    Mar 24, 2017
    15
    英文
    SoulGem
    SoulGem
    Mar 24, 2017
    16
    习惯性的写英文,锻炼自己。

    然后发现自己根本不会看……
    kooze
    kooze
    Mar 24, 2017
    17
    英文
    westlinkin
    westlinkin
    Mar 24, 2017❤️1
    18
    英文,切输入法太麻烦
    libook
    libook
    Mar 24, 2017❤️1
    19
    先看项目性质。
    如果是国际化团队项目或开源社区项目,肯定是要用英文的。

    如果是公司内部项目,而公司全都是中国员工的话,中英文无所谓。

    中英文各有利弊,主要问题是翻译问题;
    用英文的问题:“地面推广”究竟翻译成“ Ground Marketing ”还是“ Local Promotion ”,看似意思差不多,实际上可能在英语文化中是有显著区别的;再如“ Reload Function ”究竟指的是“重载功能”还是“那个叫做‘ reload ’的函数”;特别是一些汉语为基础的设计思路可能用中文就是简单的一句话,用英语就是主语从句+状语从句+定语从句+宾语从句等等的浮(Fu-)夸(-ck)集(J)博(B)体……
    用中文的问题:一些没有官方中文翻译的技术、概念强行用中文的话会很蛋疼,比如“ Buffer ”、“
    Query ”、“ Cluster ”、“ Debug ”、“ Delay ”、“ Scrum ”等等,翻开字典随便查一个就会惊呼:“卧槽根本不是我理解的那个意思呀摔!”;有时候会发现你已经很尽力在用中文写注释了,然鹅写出来要么完全看不懂,要么就有一大半都是英文单词。

    反正我现在仍然没有跳出注释语言的怪圈,怀着可以把一些代码抽出去搞成很牛 B 的开源工具的幻想仍然坚持在用英文写注释,查词典翻译的同时能够些许提升英文水平?

    有时候在想,或者为了协作效率可以有一种折中方案,每一句注释都用自己觉得能表达的最准确的语言去写,尽管会中英文交叉,但是可能是效率最高的方式。
    deeporist
    deeporist
    Mar 24, 2017❤️2
    20
    chinglish
    lsongdev
    lsongdev
    Mar 24, 2017❤️1
    21
    所以说「要关注问题本身而非形式」,最终要达到的目的是让大家看懂,中文还是英文很重要吗?
    Shura
    Shura
    Mar 24, 2017 via Android
    22
    阿里代码规范文档里有句话印象深刻:与其用半吊子的英语大家都不能理解,还不如用中文精确的描述。
    libook
    libook
    Mar 24, 2017
    23
    @song940 哈哈,好久不见
    sagaxu
    sagaxu
    Mar 24, 2017
    24
    基本不写注释,只在关键点写几句解释一下为什么这么做
    HLT
    HLT
    Mar 24, 2017
    25
    肯定英文啊
    nicevar
    nicevar
    Mar 24, 2017
    26
    公司的项目写中文,都是国人,五六年前的时候在一公司也写英文,因为那时候用 svn ,有些 ide 容易导致文件乱码,写的中文注释都没了
    自己的项目写英文,几个单词拼起来能看懂就够了,中文还要切换输入法
    momogzp
    momogzp
    Mar 24, 2017
    27
    英文,切换中英文有点麻烦。。
    tyfulcrum
    tyfulcrum
    Mar 24, 2017
    28
    @libook 重载是 overload 吧……
    loading
    loading
    Mar 24, 2017 via Android
    29
    蹩脚英文就不写了吧……
    hdbean
    hdbean
    Mar 24, 2017
    30
    能用中文写清楚的就不用中文
    ik
    ik
    Mar 24, 2017 via iPhone
    31
    看情况,极端情况用拼音😂
    jhaohai
    jhaohai
    Mar 24, 2017 via iPhone
    32
    自己英语蹩脚的话干脆就中文算了,省的麻烦,都是中国人看
    murmur
    murmur
    Mar 24, 2017
    33
    @libook 用中文的问题:一些没有官方中文翻译的技术、概念强行用中文的话会很蛋疼,比如“ Buffer ”、“
    Query ”、“ Cluster ”、“ Debug ”、“ Delay ”、“ Scrum ”等等,

    debug 除了调试还有其他意思可以翻译么
    还有 query
    catror
    catror
    Mar 24, 2017 via Android
    34
    有时候自己写的代码被几个人改过之后发现里面的中文注释全是乱码,所以就干脆改写英文注释了
    RqPS6rhmP3Nyn3Tm
    RqPS6rhmP3Nyn3Tm
    Mar 24, 2017 via iPad
    35
    我是想用拉丁文写注释的,可惜会被教授打,所以只能英文了
    strwei
    strwei
    Mar 24, 2017❤️1
    36
    /**
    * 写这段代码的时候,只有上帝和我知道它是干嘛的
    * 现在,只有上帝知道
    */
    tilv37
    tilv37
    Mar 24, 2017
    37
    我的代码一般就自己看,最多是项目同组的人一起,没得写英文的必要。再说,我也写不出英文呀~
    ydq419453527
    ydq419453527
    Mar 24, 2017
    38
    简单的会英文
    复杂的还是中文 (其实是英文不行)
    xxdd
    xxdd
    Mar 24, 2017
    39
    复杂的中文 简单的就是英文了 都是常用单词 懒得切输入法了
    Email
    Email
    Mar 24, 2017 via iPhone❤️1
    40
    一般留个磁链在注释那里
    Sapp
    Sapp
    Mar 24, 2017
    41
    英文逼格确实高,但是一两个月后我发现看注释还不如看代码...
    xvx
    xvx
    Mar 24, 2017 via iPhone
    42
    一般用中文。
    用英文的时候是拿来装逼用的。
    wohenyingyu02
    wohenyingyu02
    Mar 24, 2017 via iPhone
    43
    英文,反正没人看,改自己写的代码也不需要看注释,仅剩装 b 一个功能,
    jiangzhuo
    jiangzhuo
    Mar 24, 2017❤️1
    44
    以前上大学的时候不懂事,注释用瑞典语和挪威语写。然后被老师说了。
    因为我写的注释在老师电脑里都是ಡಡಡಡಡಡಡಡಡಡಡಡಡಡಡಡಡಡಡ
    iNohn
    iNohn
    Mar 24, 2017
    45
    https://github.com/xudaolong/CodeVar
    虽然是用于变量命名的,但注释也可参考 23333
    chairuosen
    chairuosen
    Mar 24, 2017
    46
    英文,否则写一句话还得切换输入法,比如 更新了 getSomeData 方法
    malagebidi
    malagebidi
    Mar 24, 2017 via iPhone
    47
    你写中文,不认识的老外自己去 translate 不就好了
    sxlzll
    sxlzll
    Mar 24, 2017
    48
    英文不行还是写中文吧,词不达意甚至表达错误最可怕,老外真要看就自己 google translate 吧
    visonme
    visonme
    Mar 24, 2017
    49
    如果我英文好,我会用英文注释的,不为装逼。
    des
    des
    Mar 24, 2017 via Android
    50
    用中文编程就不用发愁这个了,哈哈哈
    rashawn
    rashawn
    Mar 24, 2017 via iPhone
    51
    取决于给谁看 项目都会英文肯定写英文
    vovov
    vovov
    Mar 24, 2017
    52
    英文,懒得切换输入法!
    guyskk
    guyskk
    Mar 24, 2017
    53
    业务代码用中文,尽可能准确地表达代码的意图。
    kamen
    kamen
    Mar 24, 2017
    55
    能用英文就用英文,因为切输入法麻烦
    ltux
    ltux
    Mar 24, 2017
    56
    @libook 谁说用中文就是全程不能出现一个英文字母了么?总看过翻译版的技术书籍吧,参考里面对这些所谓的没有官方翻译的词汇的处理方式:要么直接保留英文词汇,要么翻译成中文的同时在括号里注上英文原文。
    mingyun
    mingyun
    Mar 25, 2017
    57
    @iNohn 有意思
    Biggoldfish
    Biggoldfish
    Mar 25, 2017
    58
    英文,因爲不想切換輸入法
    bestbug
    bestbug
    Mar 26, 2017 via Android
    59
    家乡话😂😂😂😂
    About   ·   Help   ·   Advertise   ·   Blog   ·   API   ·   FAQ   ·   Privacy   ·   Solana   ·   3178 Online   Highest 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 119ms · UTC 04:31 · PVG 12:31 · LAX 20:31 · JFK 23:31
    ♥ Do have faith in what you're doing.