معرفی شرکت ها
jsdoc-4.0.2
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشترتوضیحات
An API documentation generator for JavaScript.
| ویژگی | مقدار |
|---|---|
| سیستم عامل | - |
| نام فایل | jsdoc-4.0.2 |
| نام | jsdoc |
| نسخه کتابخانه | 4.0.2 |
| نگهدارنده | ['hegemonic'] |
| ایمیل نگهدارنده | ['jeffrey.l.williams@gmail.com'] |
| نویسنده | Michael Mathews |
| ایمیل نویسنده | micmath@gmail.com |
| آدرس صفحه اصلی | git+https://github.com/jsdoc/jsdoc.git |
| آدرس اینترنتی | https://github.com/jsdoc/jsdoc#readme |
| مجوز | Apache-2.0 |
# JSDoc
[](http://travis-ci.org/jsdoc/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 12.0.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](https://docs.npmjs.com/resolving-eacces-permissions-errors-when-installing-packages-globally)):
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
To install the latest development version locally, without updating your
project's `package.json` file:
npm install git+https://github.com/jsdoc/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
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](https://github.com/davidshimjs/jaguarjs-jsdoc)
+ [DocStrap](https://github.com/docstrap/docstrap)
([example](https://docstrap.github.io/docstrap))
+ [jsdoc3Template](https://github.com/DBCDK/jsdoc3Template)
([example](https://github.com/danyg/jsdoc3Template/wiki#wiki-screenshots))
+ [minami](https://github.com/Nijikokun/minami)
+ [docdash](https://github.com/clenemt/docdash)
([example](http://clenemt.github.io/docdash/))
+ [tui-jsdoc-template](https://github.com/nhnent/tui.jsdoc-template)
([example](https://nhnent.github.io/tui.jsdoc-template/latest/))
+ [better-docs](https://github.com/SoftwareBrothers/better-docs)
([example](https://softwarebrothers.github.io/admin-bro-dev/index.html))
### Build tools
+ [JSDoc Grunt plugin](https://github.com/krampstudio/grunt-jsdoc)
+ [JSDoc Gulp plugin](https://github.com/mlucool/gulp-jsdoc3)
### Other tools
+ [jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-to-markdown)
+ [Integrating GitBook with
JSDoc](https://medium.com/@kevinast/integrate-gitbook-jsdoc-974be8df6fb3)
## For more information
+ Documentation is available at [jsdoc.app](https://jsdoc.app/).
+ Contribute to the docs at
[jsdoc/jsdoc.github.io](https://github.com/jsdoc/jsdoc.github.io).
+ [Join JSDoc's Slack channel](https://jsdoc-slack.appspot.com/).
+ Ask for help on the
[JSDoc Users mailing list](http://groups.google.com/group/jsdoc-users).
+ Post questions tagged `jsdoc` to
[Stack Overflow](http://stackoverflow.com/questions/tagged/jsdoc).
## License
JSDoc is copyright (c) 2011-present Michael Mathews <micmath@gmail.com> and the
[contributors to JSDoc](https://github.com/jsdoc/jsdoc/graphs/contributors).
JSDoc is free software, licensed under the Apache License, Version 2.0. See the
file `LICENSE.md` in this distribution for more details.
نیازمندی
| مقدار | نام |
|---|---|
| ^7.20.15 | @babel/parser |
| ^0.2.1 | @jsdoc/salty |
| ^12.2.3 | @types/markdown-it |
| ^3.7.2 | bluebird |
| ^0.9.0 | catharsis |
| ^2.0.0 | escape-string-regexp |
| ^4.0.2 | js2xmlparser |
| ^3.0.0 | klaw |
| ^12.3.2 | markdown-it |
| ^8.4.1 | markdown-it-anchor |
| ^4.0.10 | marked |
| ^1.0.4 | mkdirp |
| ^0.2.3 | requizzle |
| ^3.1.0 | strip-json-comments |
| ~1.13.2 | underscore |
زبان مورد نیاز
| مقدار | نام |
|---|---|
| 18.13.0 | Npm |
نحوه نصب
نصب پکیج tgz jsdoc-4.0.2:
npm install jsdoc-4.0.2.tgz