JSDoc 3是JavaScript的API文档生成器，类似于Javadoc或phpDocumentor。 您可以直接在代码本身附加文档注释到您的源代码。 JSDoc工具将扫描您的源代码并为您生成一个HTML文档网站。
JSDoc
JSDoc 3是JavaScript的API文档生成器，类似于Javadoc或phpDocumentor。(JSDoc 3 is an API documentation generator for JavaScript, similar to Javadoc or phpDocumentor. )
Github stars Tracking Chart
Main metrics
- Overview
-
Name With Owner jsdoc/jsdoc Primary Language JavaScript Program language JavaScript (Language Count: 2) Platform License: Apache License 2.0 - 所有者活动
-
Created At 2010-03-13 09:18:03 Pushed At 2025-06-08 05:04:34 Last Commit At Release Count 385 Last Release Name jsdoc@5.0.0-dev.19 (Posted on 2025-01-15 12:31:15) First Release Name v3.0.0 (Posted on 2012-05-14 22:14:09) - 用户参与
-
Stargazers Count 15.2k Watchers Count 274 Fork Count 1.5k Commits Count 3k Has Issues Enabled Issues Count 1626 Issue Open Count 401 Pull Requests Count 237 Pull Requests Open Count 46 Pull Requests Close Count 209 - 项目设置
-
Has Wiki Enabled Is Archived Is Fork Is Locked Is Mirror Is Private
JSDoc
An API documentation generator for JavaScript.
Want to contribute to JSDoc? Please read CONTRIBUTING.md.
Installation and Usage
JSDoc supports stable versions of Node.js 8.15.0 and later. You can install
JSDoc globally or in your project's node_modules folder.
To install the latest version on npm globally (might require sudo;
learn how to fix this):
npm install -g jsdoc
To install the latest version on npm locally and save it in your package's
package.json file:
npm install --save-dev jsdoc
Note: By default, npm adds your package using the caret operator in front of
the version number (for example, ^3.6.3). We recommend using the tilde
operator instead (for example, ~3.6.3), which limits updates to the most
recent patch-level version. See
this Stack Overflow answer for
more information about the caret and tilde operators.
If you installed JSDoc locally, the JSDoc command-line tool is available in
./node_modules/.bin. To generate documentation for the file
yourJavaScriptFile.js:
./node_modules/.bin/jsdoc yourJavaScriptFile.js
If you installed JSDoc globally, run the jsdoc command:
jsdoc yourJavaScriptFile.js
By default, the generated documentation is saved in a directory named out. You
can use the --destination (-d) option to specify another directory.
Run jsdoc --help for a complete list of command-line options.
Templates and tools
The JSDoc community has created templates and other tools to help you generate
and customize your documentation. Here are a few of them:
Templates
- jaguarjs-jsdoc
- DocStrap
(example) - jsdoc3Template
(example) - minami
- docdash
(example) - tui-jsdoc-template
(example) - better-docs
(example)
Build tools
Other tools
For more information
- Documentation is available at jsdoc.app.
- Contribute to the docs at
jsdoc/jsdoc.github.io. - Join JSDoc's Slack channel.
- Ask for help on the
JSDoc Users mailing list. - Post questions tagged
jsdocto
Stack Overflow.
License
JSDoc is copyright (c) 2011-present Michael Mathews micmath@gmail.com and
the contributors to JSDoc.
JSDoc is free software, licensed under the Apache License, Version 2.0. See the
LICENSE file for more details.