1. 首页
  2. 编程语言
  3. Python
  4. 使用apidocJs快速生成在线文档的实例讲解

使用apidocJs快速生成在线文档的实例讲解

上传者: 2022-05-08 04:58:56上传 PDF文件 301.28 KB 热度 23次

apidoc是一个轻量级的在线REST接口文档生成系统,可以根据其特定的规则的代码注释来生成静态网页。apidoc支持多种主流的编码语言,包括Java、C、C#、PHP和Javascript。apidoc并不支持所有的注释,譬如Java仅中支持Javadoc风格的注释。首先要说明的是,apidoc并不具备语义识别能力,它不会发现代码中是否有BUG,它仅仅通过文件后缀来判断语言类型。关于nodeJs的安装,一搜一大把,不过为了文章的完整性,还是首先介绍一下Windows平台下nodeJs的安装。首先,去node.js官网上下载最新的安装包,请下载自己对应系统的安装包。下载完毕后,按照一般的软件安装步骤安装即可。在正式开始之前,先介绍一下apidoc中的重要命令和参数。

下载地址
用户评论