|
- Use JSDoc: Index
How to add JSDoc comments to CommonJS and Node js modules
- Use JSDoc: Getting Started with JSDoc 3
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
- Use JSDoc
The parameter type can be a built-in JavaScript type, such as string or Object, or a JSDoc namepath to another symbol in your code If you have written documentation for the symbol at that namepath, JSDoc will automatically link to the documentation for that symbol
- Use JSDoc: ES 2015 Classes
JSDoc 3 makes it easy to document classes that follow the ECMAScript 2015 specification You don't need to use tags such as @class and @constructor with ES 2015 classes—JSDoc automatically identifies classes and their constructors simply by parsing your code
- Use JSDoc
@use JSDoc Overview Provide an example of how to use a documented item The text that follows this tag will be displayed as highlighted code Examples Note that a doclet may have multiple examples Documenting examples ** * Solves equations of the form a * x = b * @example * returns 2 * globalNS method1(5, 10); * @example * returns 3
- Use JSDoc
You can use any Google Closure Compiler type expression, as well as several other formats that are specific to JSDoc If JSDoc determines that a type expression is invalid, it will display an error and stop running You can turn this error into a warning by running JSDoc with the --lenient option
- Use JSDoc: Tutorials
JSDoc allows you to include tutorials alongside your API documentation You can use this feature to provide detailed instructions for using your API, such as a "getting started" guide or a step-by-step process for implementing a feature
- Use JSDoc: Configuring JSDoc with a configuration file
To run JSDoc with a configuration file, use the -c command-line option (for example, jsdoc -c path to conf json or jsdoc -c path to conf js) The following examples show a simple configuration file that enables JSDoc's Markdown plugin
|
|
|