Skip to content
EntityQ2089685· pop 13· linked from 120 articles

جی‌اس‌داک

Sign in to save

JSDoc is a markup language used to annotate and document JavaScript code. The comments can be processed by tools to produce documentation in formats such as HTML. The JSDoc specification is released under CC BY-SA 3.0, while its companion documentation generator and parser library is licensed under the Apache License 2.0.

Key facts

File format.genre
Programming documentation Format
File format.contained by
JavaScript source files
File format.extended from
JavaDoc
File format.open
Yes

via Wikipedia infobox

Source code

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 locally and save it in your package's package.json file: 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. The JSDoc community has created templates and other tools to help you generate and customize your documentation. Here are a few of them: For more information Documentation is available at jsdoc.app. Contribute to the docs at jsdoc/jsdoc.github.io. Ask for help on the JSDoc Users mailing list. Post questions tagged jsdoc to Stack Overflow. JSDoc is free software, licensed under the Apache License, Version 2.0. See the LICENSE file for more details.

Excerpt from the source-code README · 3,633 chars · not written by Vinony