V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
V2EX 提问指南
mec
V2EX  ›  问与答

大家注释用中文还是英文

  •  
  •   mec · 2017-03-24 09:47:03 +08:00 · 11487 次点击
    这是一个创建于 2561 天前的主题,其中的信息可能已经有所发展或是发生改变。

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

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

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

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

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

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

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

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