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

请问各位是怎么看待写文档的?

  •  
  •   helica · 2017-07-07 18:40:47 +08:00 · 2292 次点击
    这是一个创建于 2696 天前的主题,其中的信息可能已经有所发展或是发生改变。

    学生党在做小学期,又到了写文档的时候。

    每次最烦的就是写文档,感觉完全破坏了写代码那种畅爽的感觉。

    请问各位程序员在工作中也经常写文档吗?还是交给专人维护?

    13 条回复    2017-07-08 10:36:38 +08:00
    ihuotui
        1
    ihuotui  
       2017-07-07 18:50:25 +08:00 via iPhone
    不会写文档程序员不是好 ceo
    jswh
        2
    jswh  
       2017-07-07 18:55:46 +08:00
    是一种技能,我做的不好,但我觉得技多不压身。
    tolerance
        3
    tolerance  
       2017-07-07 19:07:39 +08:00
    代码就是最好的文档
    mokeyjay
        4
    mokeyjay  
       2017-07-07 19:11:11 +08:00 via Android
    按照一定的规范写好注释,然后就能用生成器生成文档了
    qiqico
        5
    qiqico  
       2017-07-07 19:11:16 +08:00
    不觉得文档写得好的代码更好看吗?去看下一些优秀的开源代码~

    有时候会通过写注释来整理思路,然后根据注释框架填充代码
    libook
        6
    libook  
       2017-07-07 19:19:21 +08:00
    代码是给人看的,顺便给程序执行而已。
    我写 JS,所以会用 JSDoc 和 URIDoc 格式来用注释写文档,看代码及文档。
    你若代码极其清晰,一眼就看懂,可以不写注释或文档。
    我达不到这种程度,一边写代码一边写注释,之后还会时不时补充注释,基本上注释量和代码量一样多。
    zhuangtongfa
        7
    zhuangtongfa  
       2017-07-07 19:20:48 +08:00 via Android
    文档比单元测试还重要
    sagaxu
        8
    sagaxu  
       2017-07-07 19:37:08 +08:00 via Android
    跟前端或者 APP 对接的时候会写个文档,其它一般不写文档,也不写注释,只在几个比较关键的点,解释一下为什么这么做。
    visonme
        9
    visonme  
       2017-07-07 20:00:17 +08:00
    写和说是基本技能,也是关键技能
    littleylv
        10
    littleylv  
       2017-07-07 20:41:41 +08:00
    讨厌两种事:
    0、写文档
    1、别人不写文档
    (逃
    xmumiffy
        11
    xmumiffy  
       2017-07-07 20:58:16 +08:00 via Android
    写文档多好啊
    cxbig
        12
    cxbig  
       2017-07-07 21:09:56 +08:00
    当然要写,不然几个月后自己都不知道它是干嘛的了。
    要不是有 Git Blame 做证,我都没办法相信自己一个月前写的代码有多烂。
    wshcdr
        13
    wshcdr  
       2017-07-08 10:36:38 +08:00
    自动生成文档啊
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   实用小工具   ·   1221 人在线   最高记录 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 24ms · UTC 18:19 · PVG 02:19 · LAX 10:19 · JFK 13:19
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.