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. )
-
所有者:
jsdoc
该所有者的项目
(0)
- 平台:
- 许可证: Apache License 2.0
-
分类:
- 主题:
Github星跟踪图
主要指标
- 概览
-
名称与所有者 jsdoc/jsdoc 主编程语言 JavaScript 编程语言 JavaScript (语言数: 2) 平台 许可证 Apache License 2.0 - 所有者活动
-
创建于 2010-03-13 09:18:03 推送于 2025-10-25 12:45:49 最后一次提交 发布数 386 最新版本名称 4.0.5 (发布于 2025-10-07 19:58:35) 第一版名称 v3.0.0 (发布于 2012-05-14 22:14:09) - 用户参与
-
星数 15.3k 关注者数 267 派生数 1.5k 提交数 3k 已启用问题? 问题数 1630 打开的问题数 405 拉请求数 238 打开的拉请求数 47 关闭的拉请求数 210 - 项目设置
-
已启用Wiki? 已存档? 是复刻? 已锁定? 是镜像? 是私有?
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.