一次偶然的机会看到了 Ruby 社区的 autodoc。是一 - 沸点

@字节跳动

一次偶然的机会看到了 Ruby 社区的 autodoc。是一个通过测试用例生成 API 文档的工具。它的思路是因为测试正确，说明你的出入参肯定是正确的，就不用手动维护 API 文档了。感觉挺有意思的。

在 npm 上搜了一个好像 Node 社区还没有，五一放假就自己弄了个简单版本来玩玩 🤨。

Github:

github.com

我自己的一个想法是，现在每个公司都会有自己的文档系统，这个工具除了本地生成文档，也可以将文档的信息传到公司文档系统，然后自动生成文档网页和用例。

以后只需要在 pipline 中的 npm run test 后加一个类似 npm run docs 的命令自动同步到文档系统里，就可以实现测试->文档生成->发布的流水线，这样对 API 文档的维护会不会更高效一点？🧐

展开

赞过