代码生成文档

代码生成文档是为开发者而设计的功能。

开发者可以自行从代码直接生成API文档。

目前支持的生成文档有三种：

• API 文档

  RESTful API 文档，由APIDOC解析生成。

  前端开发者与自动评测机开发者需要关注。

  $ npm run apidoc

  打开 docs/api/index.html 即可查看。

• JS 文档

  内部接口、类、模块等的文档，由JSDOC解析生成。

  API 服务器开发者需要关注。

  $ npm run jsdoc

  打开 docs/index.html 即可查看。

• 代码测试覆盖率报告

  执行代码测试时的生成的代码测试覆盖率报告，由istanbul与mocha联合生成。

  $ npm run cover

  打开 docs/cover/index.html 即可查看。

当然，也支持同时生成 API 文档与 JS 文档：

$ npm run docs