请问webman如何安装使用apidoc

lianggan

请问webman如何安装使用apidoc

1376 1 1
1个回答

nitron

不是用npm/yarn安装了apidoc之后,在代码里按apidoc的方式注释就可以了么?
然后用apidoc生成

  • nitron 2022-03-08

    纯生成文档的话,不影响,apidoc的主要功能不就是从代码注释里提取内容生成文档么,其他的需求可能是非必要而且可替代吧

  • lianggan 2022-03-08

    npm install apidoc -g 安装之后在怎么在webman里面用呀

  • nitron 2022-03-08

    在你的Webman的controller按照apidoc的方式写注释啊,
    写完后如果需要把controller内的注释生成api doc就

    apidoc -i app/controller -o docs  

    这样就在当前目录下生成docs目录,里面是apidoc生成的文档

  • lianggan 2022-03-08

    我试试谢谢

  • lianggan 2022-03-08

    那我如果apidoc -i app/controller -o docs 我应该放在 webman哪个目录中呢

  • Tinywan 2022-03-08

    推荐 public

  • nitron 2022-03-08

    你在webman目录下运行这个

  • nitron 2022-03-08

    -i 是你要扫描的目录 -o 是你要输出到的目录

  • lianggan 2022-03-08

    好的,谢谢

年代过于久远,无法发表回答
×
🔝