• 请不要在回答技术问题时复制粘贴 AI 生成的内容
fundebug
V2EX  ›  程序员

注释写得太多了会挨打吗?

  •  
  •   fundebug · Sep 25, 2018 · 19145 views
    This topic created in 2970 days ago, the information mentioned may be changed or developed.

    145 replies  •  2018-09-27 18:27:25 +08:00
    1  2  
    ❮ ❯
    whypool
    whypool
    Sep 25, 2018
    1
    会,把注释当文档了
    pain400
    pain400
    Sep 25, 2018
    2
    挺好的
    orange1818
    orange1818
    Sep 25, 2018
    3
    我已经备好手枪了
    easylee
    easylee
    Sep 25, 2018 via Android
    4
    一份经久不衰的代码,注释量与代码量的比应该至少为 2:1。
    fundebug
    fundebug
    OP
    Sep 25, 2018❤️1
    5
    @orange1818 《刑法》第一百二十八条第一款的罪名为非法持有、私藏枪支、弹药罪。该款规定:违反枪支管理规定,非法持有、私藏枪支、弹药的,处三年以下有期徒刑、拘役或者管制;情节严重的,处三年以上七年以下有期徒刑。
    smilepig
    smilepig
    Sep 25, 2018
    6
    详细点是蛮好的。。。
    wupher
    wupher
    Sep 25, 2018❤️7
    7
    别的都还好,console.warn 我笑了
    Mariano
    Mariano
    Sep 25, 2018
    8
    随便看了一眼,密密麻麻的字看的我头疼
    yulitian888
    yulitian888
    Sep 25, 2018❤️2
    9
    不写注释才会被打呢
    比如下面这样的:

    /*

    +---------------+
    | |
    | 本数据库操作类 |
    | |
    +--+--+---------+
    | ^
    v |
    |
    +-----+---------+
    | |
    | 数据库 |
    | |
    | |
    +---------------+



    */
    ranoff
    ranoff
    Sep 25, 2018
    10
    个人觉得的有点多
    zhangjiabin1010
    zhangjiabin1010
    Sep 25, 2018
    11
    喜闻乐见啊,多写点注释,方便你我他
    yangxiongguo
    yangxiongguo
    Sep 25, 2018
    12
    导出一下就是文档了啊
    devtk
    devtk
    Sep 25, 2018
    13
    写多了我不知道,写少了可能会被同事强杀
    keinx
    keinx
    Sep 25, 2018❤️9
    14
    有个同事写的注释特别有意思,注释里面带了很多段子,有时候找 BUG 找的心烦,看到他的诡异注释还是挺不错的。
    depress
    depress
    Sep 25, 2018❤️5
    15
    我要是接手一个项目注释这么详细,我会请那个人吃顿饭,而且这个注释好在是在代码块外,如果是代码中,注释比代码还多,影响阅读代码那体验就很糟了。
    mztql
    mztql
    Sep 25, 2018
    16
    规规整整的多好啊
    janxin
    janxin
    Sep 25, 2018❤️1
    17
    没有 fuck,表明这段注释和代码是一个人写的 XD
    HuHui
    HuHui
    Sep 25, 2018 via Android
    18
    工作严重不饱和
    SamsonWang
    SamsonWang
    Sep 25, 2018
    19
    注释详细点挺好的
    maichael
    maichael
    Sep 25, 2018
    20
    jsdoc 的话,选填属性应该这么写

    ```
    @param {string} [somebody] - Somebody's name.
    ```
    zhangyichent
    zhangyichent
    Sep 25, 2018
    21
    整整齐齐的没人不喜欢,怕的是乱七八糟不知所谓的注释。。。
    endlessing
    endlessing
    Sep 25, 2018❤️1
    22
    注释不嫌多,怕的是啰嗦表述不清的
    zwwhdls
    zwwhdls
    Sep 25, 2018
    23
    @yulitian888 写了注释,跟代码不一样才会被打呢
    param
    param
    Sep 25, 2018
    24
    那就要问问 @returns 同学了
    sampeng
    sampeng
    Sep 25, 2018 via iPhone
    25
    这么多参数。提一个 obj 封装一下可好…
    AV1
    AV1
    Sep 25, 2018 via Android❤️1
    26
    注释跟代码不一致,误导读者的,才会被打。
    zjp
    zjp
    Sep 25, 2018 via Android
    27
    mockio 推崇注释即文档,异常信息还带正确示范
    anyele
    anyele
    Sep 25, 2018 via Android
    28
    挺好的,
    moresteam
    moresteam
    Sep 25, 2018 via Android
    29
    0 注释的路过
    hheedat
    hheedat
    Sep 25, 2018
    30
    我觉得还行
    zwh2698
    zwh2698
    Sep 25, 2018 via Android
    31
    有枪🔫
    firenine
    firenine
    Sep 25, 2018
    32
    这就体现 ts 的好处了,不用写这种注释
    way2create
    way2create
    Sep 25, 2018
    33
    想起了上次那个画注释的帖子
    cjpjxjx
    cjpjxjx
    Sep 25, 2018 via iPhone❤️2
    34
    这是前人栽树后人乘凉,比前人挖坑后人骂娘好多了
    tangweihua163
    tangweihua163
    Sep 25, 2018
    35
    参数这么多…就不是注释的问题了…
    kerr92
    kerr92
    Sep 25, 2018
    36
    像 20 楼说的,string/boolean/number 一般首字母小写,optional 的属性一般用中括号括起来。
    fademeter
    fademeter
    Sep 25, 2018 via Android
    37
    至少不会枪毙。
    zcjfesky
    zcjfesky
    Sep 25, 2018 via Android
    38
    当你接盘别人的项目的时候就知道这种耐心注释的选手简直就是天使…
    zhzer
    zhzer
    Sep 25, 2018
    39
    实在看不下去,可以让 ide 隐藏注释嘛
    flight2006
    flight2006
    Sep 25, 2018
    40
    注释是好习惯,这个注释明显啰嗦了,‘一般 xxx ’后面的都可以省略,说了等于白说
    entimm
    entimm
    Sep 25, 2018 via Android
    41
    把代码写成白话文不是更好吗
    Yuicon
    Yuicon
    Sep 25, 2018
    42
    这么一看 java 虽然啰嗦点 但是可以少写很多 ‘注释’
    sonyxperia
    sonyxperia
    Sep 25, 2018
    43
    我觉得挺好
    lightening
    lightening
    Sep 25, 2018❤️1
    44
    信息太多会让真正重要的信息无法找到
    wsxyeah
    wsxyeah
    Sep 25, 2018
    45
    命名很重要,窃以为见名知意要比写一大堆冗余的注释要好得多
    xuanbg
    xuanbg
    Sep 25, 2018
    46
    挺好的,排版再对齐一下就更好了。
    oxoxoxox
    oxoxoxox
    Sep 25, 2018 via Android
    47
    这种注释挺好的 标准做法 直接就能导出成文档了 应该鼓励
    乱写注释才会被人打
    fundebug
    fundebug
    OP
    Sep 25, 2018
    48
    @lightening 注释应该言简意赅!
    framehouse
    framehouse
    Sep 25, 2018 via iPhone
    49
    有点啰嗦,不过看十行弱智注释也好过看一行莫名其妙的代码
    gbin
    gbin
    Sep 25, 2018 via Android
    50
    @sampeng 参数 option 本身就是一个对象
    neilp
    neilp
    Sep 25, 2018
    51
    太闲 了
    bfpiaoran
    bfpiaoran
    Sep 25, 2018
    52
    我咋觉得遇到这种开发就该嫁了呢
    catror
    catror
    Sep 25, 2018 via Android
    53
    写给别人使用的接口就应该写这样的注释,然而,你会发现调用接口的人还是会来问你 :|
    PP
    PP
    Sep 25, 2018
    54
    可以直接加薪。
    lijun0926
    lijun0926
    Sep 25, 2018 via iPhone
    55
    挺规范
    hellodigua
    hellodigua
    Sep 25, 2018
    56
    学习了……
    hotsymbol
    hotsymbol
    Sep 25, 2018
    57
    看的想死
    imn1
    imn1
    Sep 25, 2018
    58
    挨打是小事……
    nodin
    nodin
    Sep 25, 2018 via Android
    59
    简洁明了的注释没人不喜欢,外行人也能看明白这代码用来做什么的注释肯定是好注释。
    jmc891205
    jmc891205
    Sep 25, 2018❤️2
    60
    時間久了發現實現和註釋不一樣了:(
    fyibmsd
    fyibmsd
    Sep 25, 2018
    61
    你已经是个死人了
    SoulGem
    SoulGem
    Sep 25, 2018 via iPhone
    62
    有点多说实话,这种 option 的注释写成文档会好一点。
    scys
    scys
    Sep 25, 2018
    63
    不要对一个参数写三行注释就行。
    一页纸有 80%都是注释的代码,我看不下去。
    northernlights
    northernlights
    Sep 26, 2018 via Android
    64
    这是在写代码还是在写注释呢?垃圾代码写的注释再多也是垃圾代码,好代码不写注释也能让人一眼明白作者的思路。
    looseChen
    looseChen
    Sep 26, 2018
    65
    @northernlights 你能够一眼分辨出别人拉出来的屎? 抱歉 话有点糙
    kslr
    kslr
    Sep 26, 2018 via Android
    66
    我只会写思路和需要注意的部分
    Crixs
    Crixs
    Sep 26, 2018
    67
    注释可以直接生成文档的,你这样省了写文档的工作,不是挺好的么,Java 代码大部分文档不都这样生成的么,一堆人连编程规范都没读过吧。
    Howlaind
    Howlaind
    Sep 26, 2018 via Android
    68
    干脆搞文学式编程得了
    bk201
    bk201
    Sep 26, 2018
    69
    维护起来相当麻烦,注释不应该面面俱到,应该关注重点.
    Lawlieti
    Lawlieti
    Sep 26, 2018
    70
    出来挨打
    MaxTan
    MaxTan
    Sep 26, 2018
    71
    文档注释写再多都不怕。
    a = 1; //给变量 a 赋值 这种直接打死
    allgy
    allgy
    Sep 26, 2018
    72
    代码不够注释凑
    aaronysj
    aaronysj
    Sep 26, 2018
    73
    参数是不是有点多
    wqzjk393
    wqzjk393
    Sep 26, 2018❤️1
    74
    flask 源码了解下。。满屏幕的注释
    psklf
    psklf
    Sep 26, 2018
    75
    我推荐多写注释,越详细越好。
    zhaogaz
    zhaogaz
    Sep 26, 2018
    76
    最好写成类似 javadoc 的那种,能直接生成文档。

    其他的注释只保留极少部分 必要的就够了。

    能做到以上 2 条的,基本是很优秀了。
    kingwl
    kingwl
    Sep 26, 2018❤️2
    77
    gesse
    gesse
    Sep 26, 2018
    78
    下注释的习惯是好的, 不过这个代码能力有待商榷
    TomatoYuyuko
    TomatoYuyuko
    Sep 26, 2018
    79
    同步 xhr 要被封杀么,哪里的消息
    ben1024
    ben1024
    Sep 26, 2018
    81
    不推荐写注释,写注释是因为看代码不知道在做什么
    4everYang
    4everYang
    Sep 26, 2018
    82
    如果注释跟代码是一致的请他吃饭啊
    Linxing
    Linxing
    Sep 26, 2018
    83
    你敢不写试试?
    Edwards
    Edwards
    Sep 26, 2018
    84
    接受代码写得不好,但是不接受文档写的不好的,同理注释。
    NicholasYX
    NicholasYX
    Sep 26, 2018
    85
    一打眼就能看明白的没有必要写注释吧……
    xpresslink
    xpresslink
    Sep 26, 2018
    86
    @fundebug
    python 有一个专门生成文档的工具叫 sphinx,自己从代码中抽取注释生成结构化的 HTML 文档。
    flask 的文档就是这么生成的。
    好处是文档和代码是在一起的便于维护更新,每个人在代码里写自己的文档就好了。
    最后只要生成一下就是最新的文档了,不用费力有专人去维护文档的一致性。
    q397064399
    q397064399
    Sep 26, 2018
    87
    @fundebug #80 Python 没有注释 就没法合作了,这种动态语言 是真的令人难受
    brondogk886
    brondogk886
    Sep 26, 2018
    88
    这么全面的注释,不维护的话估计会被人打死
    xxl11231220
    xxl11231220
    Sep 26, 2018
    89
    求之不得。表示嫌弃不写少些注释的
    mN71eOOprFyMsnPx
    mN71eOOprFyMsnPx
    Sep 26, 2018
    90
    代码应该做到自解释,你这样如果精力不够时,很容易出现注释和代码不同步,最终更加误导人。
    junbaor
    junbaor
    Sep 26, 2018
    91
    看起来这是个稍微底层的方法,这注释写的,完美~
    northernlights
    northernlights
    Sep 26, 2018
    92
    @looseChen 我可没这本事,看来你经验丰富,你自己去吃吧。
    tiedan
    tiedan
    Sep 26, 2018
    93
    待过一家公司都不让写注释
    noNOno
    noNOno
    Sep 26, 2018
    94
    还是蛮好的
    ioth
    ioth
    Sep 26, 2018
    95
    我会比较尊重这样的孩子。
    Mavious
    Mavious
    Sep 26, 2018
    96
    作为新手,最喜欢注释多多的代码了,每一行的功能都能靠注释看懂。
    多多益善。
    ljspython
    ljspython
    Sep 26, 2018
    97
    注释永远不嫌多
    nomemo
    nomemo
    Sep 26, 2018
    98
    挺不错的,就是要持续维护
    AllenW
    AllenW
    Sep 26, 2018
    99
    这注释 厉害了
    sorra
    sorra
    Sep 26, 2018
    100
    写错了才挨打
    1  2  
    ❮ ❯
    About   ·   Help   ·   Advertise   ·   Blog   ·   API   ·   FAQ   ·   Privacy   ·   Solana   ·   998 Online   Highest 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 223ms · UTC 22:38 · PVG 06:38 · LAX 14:38 · JFK 17:38
    ♥ Do have faith in what you're doing.