JSDoc is a tool for generating documentation for JavaScript code. Learn how to use JSDoc tags, plugins, configuration files, and templates to document your code and create API documentation.
Using namepaths with JSDoc Namepaths in JSDoc. When referring to a JavaScript variable that is elsewhere in your documentation, you must provide a unique identifier that maps to that variable. A namepath provides a way to do so and disambiguate between instance members, static members and inner variables. Basic Syntax Examples of Namepaths in JSDoc
JSDoc 3 is an API documentation generator for JavaScript, similar to Javadoc or phpDocumentor. You add documentation comments directly to your source code, right alongside the code itself. The JSDoc tool will scan your source code and generate an HTML documentation website for you.
Document the parameter to a function. @use JSDoc Synonyms. arg; argument; Overview. The @param tag provides the name, type, and description of a function parameter.. The @param tag requires you to specify the name of the parameter you are documenting. You can also include the parameter's type, enclosed in curly brackets, and a description of the parameter.
@use JSDoc Synonyms. var; Syntax. @member [<type>] [<name>] Overview. The @member tag identifies any member that does not have a more specialized kind, such as "class", "function", or "constant". A member can optionally have a type as well as a name. Examples Using @member with Data#point /** @class */ function Data { /** @member {Object} */ this. point = {}; } Here is an example of using @var ...
Vidéos
https://github.com › jsdoc › jsdoc
jsdoc/jsdoc: An API documentation generator for JavaScript. - GitHubJSDoc is a tool that generates documentation for JavaScript code from comments. Learn how to install, use, customize and contribute to JSDoc on GitHub.
https://en.wikipedia.org › wiki › JSDoc
JSDoc - WikipediaJSDoc is a format for annotating JavaScript source code files with comments that describe the application programming interface. It is inspired by JavaDoc and supports various tools to generate HTML and Rich Text Format documentation.
https://jsdoc.app › about-getting-started
Getting Started with JSDoc 3Learn how to use JSDoc 3 to document your JavaScript code with comments and tags. Generate an HTML website from your source files with the JSDoc tool.
https://fr.wikipedia.org › wiki › JSDoc
JSDoc — WikipédiaJSDoc est un langage de balisage pour documenter les codes sources JavaScript. Il utilise des commentaires avec des tags similaires à Javadoc, et permet de générer des documents HTML, RTF ou autres formats.
Learn how to use the @type tag to specify the type of a symbol, parameter, or return value in JSDoc comments. See examples of different type expressions, such as arrays, objects, unions, nullable and optional types.
https://nikolasbarwicki.com › articles › mastering-jsdoc-the-complete-guide-for-javascript...
Mastering JSDoc: complete guide for Javascript developersLearn how to use JSDoc, a markup language to describe the structure and behavior of Javascript code. See examples of JSDoc syntax, tags, benefits, and best practices for documenting your code effectively.
https://runebook.dev › fr › docs › jsdoc › about-getting-started
Premiers pas avec le JSDoc 3 - Runebook.devJSDoc 3 vous permet d'ajouter des commentaires de documentation directement à votre code source JavaScript et de générer un site Web à partir de vos fichiers sources. Découvrez comment utiliser les balises JSDoc, le modèle HTML et l'outil jsdoc pour documenter votre API.
https://runebook.dev › fr › docs › jsdoc
JSDoc [fr] - Runebook.devJSDoc est un outil de documentation pour le JavaScript qui utilise des commentaires pour générer des documents. Découvrez comment utiliser JSDoc 3, ses balises, ses plugins, ses exemples et ses tutoriels.
https://github.com › jsdoc › jsdoc › blob › main › README.md
jsdoc/README.md at main - GitHubJSDoc is free software, licensed under the Apache License, Version 2.0. See the LICENSE file for more details. An API documentation generator for JavaScript. Contribute to jsdoc/jsdoc development by creating an account on GitHub.
