一次偶然的机会看到了 Ruby 社区的 autodoc。是一个通过测试用例生成 API 文档的工具。它的思路是因为测试正确,说明你的出入参肯定是正确的,就不用手动维护 API 文档了。感觉挺有意思的。 在 npm 上搜了一个好像 Node 社区还没有,五一放假就自己弄了个简单版本来玩玩 🤨。 Github: https://github.com/Haixiang6123/node-autodocgithub.com 我自己的一个想法是,现在每个公司都会有自己的文档系统,这个工具除了本地生成文档,也可以将文档的信息传到公司文档系统,然后自动生成文档网页和用例。 以后只需要在 pipline 中的 npm run test 后加一个类似 npm run docs 的命令自动同步到文档系统里,就可以实现测试->文档生成->发布的流水线,这样对 API 文档的维护会不会更高效一点?🧐
展开
4
分享一份新鲜出炉的造轮子小书:《一天学习一个轮子系列》,十天后变成轮子哥!💪
1
海怪的头像
前端开发 @ 深圳腾讯
海怪的头像
前端开发 @ 深圳腾讯
【腾讯在线教育前端招聘】 校招、实习 HC 巨多,特别缺人。期待优秀的你~ 办公地点:深圳万利达大厦。 简历无脑直接递到组长,请发: haixiang6123@gmail.com
展开
评论
海怪的头像
前端开发 @ 深圳腾讯
海怪的头像
前端开发 @ 深圳腾讯
个人成就
获得点赞60
文章被阅读3,528
掘力值95
收藏集
1
关注标签
2
加入于