V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
爱意满满的作品展示区。
Haixiang
V2EX  ›  分享创造

[开源] 一个测试驱动文档的生成器

  •  1
     
  •   Haixiang ·
    haixiangyan · 2021-05-03 19:54:44 +08:00 · 1173 次点击
    这是一个创建于 1060 天前的主题,其中的信息可能已经有所发展或是发生改变。

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

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

    Github: https://github.com/Haixiang6123/node-autodoc

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

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

    1 条回复    2021-05-04 15:55:44 +08:00
    abersheeran
        1
    abersheeran  
       2021-05-04 15:55:44 +08:00
    很有意思的思路!
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   我们的愿景   ·   实用小工具   ·   2558 人在线   最高记录 6543   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 25ms · UTC 15:57 · PVG 23:57 · LAX 08:57 · JFK 11:57
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.