jsdoc

2019-01-12 admin

jsdoc是什么

什么是jsdoc,An API documentation generator for JavaScript.

jsdoc使用教程帮助文档

JSDoc 3

Build Status

An API documentation generator for JavaScript.

Want to contribute to JSDoc? Please read CONTRIBUTING.md.

Installation and Usage

JSDoc supports Node.js 4.2.0 and later. You can install JSDoc globally or in your project’s node_modules folder.

To install the latest version on npm globally (may 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.5.2). We recommend using the tilde operator instead (for example, ~3.5.2), which limits updates to the most recent patch-level version. See this Stack Overflow answer for more information about the caret and tilde operators.

To install the latest development version locally, without updating your project’s package.json file:

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

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

Or if you installed JSDoc globally, simply 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 numerous templates and other tools to help you generate and customize your documentation. Here are just a few:

Templates

Build Tools

Other Tools

For More Information

License

JSDoc 3 is copyright © 2011-present Michael Mathews micmath@gmail.com and the contributors to JSDoc.

JSDoc 3 is free software, licensed under the Apache License, Version 2.0. See the file LICENSE.md in this distribution for more details.

本站文章除注明转载外,均为本站原创或编译。欢迎任何形式的转载,但请务必注明出处。

转载请注明:文章转载自 JavaScript中文网 [https://www.javascriptcn.com]

本文地址:https://www.javascriptcn.com/read-50813.html

文章标题:jsdoc

相关文章
update-markdown-jsdoc
update-markdown-jsdoc是什么 什么是update-markdown-jsdoc,Updates a markdown document section with jsdoc documentation. update-...
2018-11-16
How to document a dictionary in JSDoc?
Áxel Costas Pena提出了一个问题:How to document a dictionary in JSDoc?,或许与您遇到的问题类似。 回答者Áxel Costas Pena给出了该问题的处理方式: According to...
2018-04-24
jaguarjs-jsdoc
jaguarjs-jsdoc是什么 什么是jaguarjs-jsdoc,Jaguar.js template for JSDoc 3 jaguarjs-jsdoc官网:官网 jaguarjs-jsdoc源码仓库:源码仓库 jaguarjs...
2018-11-23
如何显示参数是可选的使用内联JsDoc?
studgeek提出了一个问题:How to indicate param is optional using inline JSDoc?,或许与您遇到的问题类似。 回答者studgeek给出了该问题的处理方式: I found a way...
2018-03-25
What's the proper way to document callbacks with jsdoc?
rdegges提出了一个问题:What’s the proper way to document callbacks with jsdoc?,或许与您遇到的问题类似。 回答者Jeff Williams给出了该问题的处理方式: JSDoc 3...
2018-04-15
tui-jsdoc-template
tui-jsdoc-template是什么 什么是tui-jsdoc-template,Toast UI JSDoc Template tui-jsdoc-template官网:官网 tui-jsdoc-template源码仓库:源码仓库...
2019-02-12
babel-plugin-jsdoc-to-assert
babel-plugin-jsdoc-to-assert是什么 什么是babel-plugin-jsdoc-to-assert,Babel plugin convert jsdoc to assertion. babel-plugin-j...
2018-10-02
babel-preset-jsdoc-to-assert
babel-preset-jsdoc-to-assert是什么 什么是babel-preset-jsdoc-to-assert,babel preset for jsdoc-to-assert babel-preset-jsdoc-to-...
2018-10-02
gulp-jsdoc3
gulp-jsdoc3是什么 什么是gulp-jsdoc3,gulp integration for jsdoc3 cli gulp-jsdoc3官网:官网 gulp-jsdoc3源码仓库:源码仓库 gulp-jsdoc3下载地址:点此下...
2018-11-21
Why Doesn't jQuery use JSDoc? [closed]
hlfcoding提出了一个问题:Why Doesn’t jQuery use JSDoc? [closed],或许与您遇到的问题类似。 回答者Scott RippeyNick Craver给出了该问题的处理方式: I’ll take a ...
2018-04-17
回到顶部