By Tanf

Updated:

Contents
  1. 1. 安装与用法
    1. 1.1. Node.js
      1. 1.1.1. 利用Node.js安装jsdoc
      2. 1.1.2. 在Node.js上运行jsdoc
    2. 1.2. 参考

英文版

编译版本

jsdoc是一个面向Javascript API文档生成器。

安装与用法

你可以在Node.js上安装运行jsdoc。

Node.js

首先你需要安装Node.js，不知道的上官网Node.js。

利用Node.js安装jsdoc

稳定版

1

npm install jsdoc@"<=3.3.0"

开发版

1

npm install git+https://github.com/jsdoc3/jsdoc.git

在Node.js上运行jsdoc

1

./node_modules/.bin/jsdoc yourJavaScriptFile.js

如果你在环境变量path中配置了全局访问，那么就可以在命令行任意位置输入以下命令进行编译。

1

jsdoc yourJavaScriptFile.js

jsdoc默认输出文档文件的目录是out，你也可以通过

1
2

运行
jsdoc —help ```可以查看命令行参数清单

译者：tandaly

参考

Contents
  1. 1. 安装与用法
    1. 1.1. Node.js
      1. 1.1.1. 利用Node.js安装jsdoc
      2. 1.1.2. 在Node.js上运行jsdoc
    2. 1.2. 参考