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星跟蹤圖
主要指標
- 概覽
-
名稱與所有者 jsdoc/jsdoc 主編程語言 JavaScript 編程語言 JavaScript (語言數: 2) 平台 許可證 Apache License 2.0 - 所有者活动
-
創建於 2010-03-13 09:18:03 推送於 2025-06-28 01:27:38 最后一次提交 發布數 385 最新版本名稱 jsdoc@5.0.0-dev.19 (發布於 2025-01-15 12:31:15) 第一版名稱 v3.0.0 (發布於 2012-05-14 22:14:09) - 用户参与
-
星數 15.3k 關注者數 274 派生數 1.5k 提交數 3k 已啟用問題? 問題數 1627 打開的問題數 402 拉請求數 237 打開的拉請求數 46 關閉的拉請求數 209 - 项目设置
-
已啟用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.