V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
davidway
V2EX  ›  Java

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

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

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

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

    而写 Junit 当然是为了把设计尽量做到最优,因为我们写一个 junit 的时候,是为了直接实现功能,而忽略功能的内部细节,所以用 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   ·   实用小工具   ·   1043 人在线   最高记录 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 78ms · UTC 19:29 · PVG 03:29 · LAX 11:29 · JFK 14:29
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.