【文件属性】：
文件名称：apidoc：RESTful Web API文档生成器
文件大小：513KB
文件格式：ZIP
更新时间：2021-02-23 07:07:51
HTML
apiDoc
apiDoc根据您源代码中的API描述创建文档。
说明文件：
输出。
安装
$ npm install -g apidoc
用法
在源代码中的任意位置添加一些apidoc注释：
/**
* @api {get} /user/:id Request User information
* @apiName GetUser
* @apiGroup User
*
* @apiParam {Number} id User's unique ID.
*
* @apiSuccess {String} firstname Firstname of the User.
* @apiSuccess {String} lastname Lastname of the User.
*/
现在将文档从src/成为doc/ 。
$ apidoc -i src/ -o d
【文件预览】：
apidoc-master
----.travis.yml(110B)
----bin()
--------apidoc(5KB)
----.jshintignore(32B)
----example()
--------header.md(938B)
--------apidoc.json(528B)
--------example.js(4KB)
--------_apidoc.js(3KB)
--------footer.md(2KB)
----template-single()
--------build-single.sh(3KB)
--------index.html(587KB)
----package.json(2KB)
----.github()
--------PULL_REQUEST_TEMPLATE.md(196B)
--------ISSUE_TEMPLATE()
--------workflows()
----test()
--------custom_markdown_parser_test.js(4KB)
--------apidoc_test.js(5KB)
--------multi_input_folder()
--------multi_input_folder_test.js(3KB)
--------template_tests.js(9KB)
--------template()
--------fixtures()
----Dockerfile(695B)
----CONTRIBUTORS.md(278B)
----LICENSE(1KB)
----package-lock.json(117KB)
----CONTRIBUTING.md(402B)
----.npmignore(79B)
----.gitignore(60B)
----CHANGELOG.md(22KB)
----lib()
--------package_info.js(6KB)
--------index.js(7KB)
----.dockerignore(23B)
----.npmrc(36B)
----README.md(5KB)
----MARKDOWN.md(2KB)
----.editorconfig(241B)
----template()
--------css()
--------vendor()
--------locales()
--------img()
--------fonts()
--------index.html(29KB)
--------main.js(32KB)
--------utils()