编写一个好的API,不光是代码写得好,最重要的是文档写得好。但是我们在写文档的时候尝尝会遇到下面几个问题:

没有统一的编写规范,这样不同的人在维护的时候尝尝会导致文档越来越乱,最终无法继续维护,也无法阅读。

API修改以后,文档没有跟着改,或者改错了,导致API的使用者无法正常调用。

作为前端开发,往往是在API开发完成以前,就要根据API的文档准备一些mock data来帮助开发,如果API文档可......

发布于2016年02月25日 09时24分,被围观2295次,留下了0脚印立即阅读