Java 程序员为什么写 doc 和测试程序?怎样写 doc 和测试程序? - V2EX
V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
davidway
V2EX    Java

Java 程序员为什么写 doc 和测试程序?怎样写 doc 和测试程序?

  •  
  •   davidway 2017-03-14 13:57:13 +08:00 2604 次点击
    这是一个创建于 3208 天前的主题,其中的信息可能已经有所发展或是发生改变。

    我看别人开发项目的时候都说要写 doc 和写测试程序。。

    而且我现在也越来越觉的写 doc 和写程序程序对开发的帮助很大,为什么呢?因为开发的时候我们不一定理解需求,而写 doc 会帮我们进一步理解需求,进而减少代码的修改率。也给测试同志和前端同志们更好地测试我们的程序。

    而写 Junit 当然是为了把设计尽量做到最优,因为我们写一个 unit 的时候,是为了直接实现功能,而忽略功能的内部细节,所以用 Junit 来表达的话,能让我们更关注关键问题。

    你们呢?

    1.为什么要写 doc 和测试程序 Junit ?

    2.还有下写 doc 和测试程序是在什么时候写的?

    3.怎么样写一个 doc 和一个测试程序?

    4.有什么工具能帮助我们写 doc 和测试程序? markdown?写文档 mock 写 junit ?

    davidway
        1
    davidway  
    OP
       2017-03-15 09:08:00 +08:00
    自己顶
    thinkmore
        2
    thinkmore  
       2017-03-15 09:54:25 +08:00   1
    1. 为了规范以及以后有理有据可寻,文档也是为了避免以后扯皮,当然规范开发流程也是应有之意

    2. 不同的文档在不同的开发阶段写,可能设计文档要在编码前写,然后提交测试文档应该在编码完成之后写,测试程序当然是在你的代码功能较为完善的时候写了

    3. 一般公司内部都有自己的文档模板,按照要求的写即可,至于测试程序只要测试功能通过就行

    4. 写 doc 确实没啥好的帮助,如果贵司比较自由可以用 markdown 写,现在 markdown 转 html , word 也是比较容易的。至于测试程序和开发同事规范一下就好,只要不是一个写 junit 一个写 main 就行。
    davidway
        3
    davidway  
    OP
       2017-03-15 11:03:26 +08:00
    @thinkmore 但是我司没有文档模版,可否发一发贵司的模版到邮箱 [email protected]?
    thinkmore
        4
    thinkmore  
       2017-03-15 11:13:13 +08:00
    @davidway 不好意思,我司文档不能外泄。你可以网上找一下对应的模板,然后慢慢让大家都是用这个就行了
    关于     帮助文档     自助推广系统     博客     API     FAQ     Solana     4586 人在线   最高记录 6679       Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 29ms UTC 03:57 PVG 11:57 LAX 19:57 JFK 22:57
    Do have faith in what you're doing.
    ubao msn snddm index pchome yahoo rakuten mypaper meadowduck bidyahoo youbao zxmzxm asda bnvcg cvbfg dfscv mmhjk xxddc yybgb zznbn ccubao uaitu acv GXCV ET GDG YH FG BCVB FJFH CBRE CBC GDG ET54 WRWR RWER WREW WRWER RWER SDG EW SF DSFSF fbbs ubao fhd dfg ewr dg df ewwr ewwr et ruyut utut dfg fgd gdfgt etg dfgt dfgd ert4 gd fgg wr 235 wer3 we vsdf sdf gdf ert xcv sdf rwer hfd dfg cvb rwf afb dfh jgh bmn lgh rty gfds cxv xcv xcs vdas fdf fgd cv sdf tert sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf shasha9178 shasha9178 shasha9178 shasha9178 shasha9178 liflif2 liflif2 liflif2 liflif2 liflif2 liblib3 liblib3 liblib3 liblib3 liblib3 zhazha444 zhazha444 zhazha444 zhazha444 zhazha444 dende5 dende denden denden2 denden21 fenfen9 fenf619 fen619 fenfe9 fe619 sdf sdf sdf sdf sdf zhazh90 zhazh0 zhaa50 zha90 zh590 zho zhoz zhozh zhozho zhozho2 lislis lls95 lili95 lils5 liss9 sdf0ty987 sdft876 sdft9876 sdf09876 sd0t9876 sdf0ty98 sdf0976 sdf0ty986 sdf0ty96 sdf0t76 sdf0876 df0ty98 sf0t876 sd0ty76 sdy76 sdf76 sdf0t76 sdf0ty9 sdf0ty98 sdf0ty987 sdf0ty98 sdf6676 sdf876 sd876 sd876 sdf6 sdf6 sdf9876 sdf0t sdf06 sdf0ty9776 sdf0ty9776 sdf0ty76 sdf8876 sdf0t sd6 sdf06 s688876 sd688 sdf86