Documenting JavaScript Programs

JSDoc

JSDoc is an API documentation generator for JavaScript, similar to Javadoc. 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.

@use JSDoc

jsdoc npm package,

JSDoc format: Wikipedia
An introduction to JSDoc
Book Speaking JavaScript: An In-Depth Guide for Programmers by Dr. Axel Rauschmayer: Chapter 29. JSDoc: Generating API Documentation
JSDoc grammars:
- PegJS grammar jsdoctypeparser/jsdoctypeparser/peg_src/jsdoctype.pegjs
- PegJS hegemonic/catharsis/lib/parser.pegjs or Google Closure Compiler and JSDoc type expressions.

jsdoc-to-markdown

jsdoc-to-markdown generates markdown API documentation from jsdoc annotated source code. Useful for injecting API docs into project README files.

1. Document your code using valid jsdoc comments.

/**
 * A quite wonderful function.
 * @param {object} - Privacy gown
 * @param {object} - Security
 * @returns {survival}
 */
function protection (cloak, dagger) {}

2. Run a command.

$ jsdoc2md example.js

3. Get markdown output.

 
## protection `(cloak, dagger) ⇒ <code>survival</code>`
A quite wonderful function.
 
**Kind**: global function
 
| Param  | Type                | Description  |
| ------ | ------------------- | ------------ |
| cloak  | `object`            | Privacy gown |
| dagger | `object`            | Security     |

Vuepress Autodoc Plugin

See https://bprinty.github.io/vuepress-plugin-autodoc/#overview

Docco

docco

How to Make Man pages

The module documentation.js

!!!include(/topics/introduction-to-javascript/documentation-guide.md)!!!

References about Documentación.js

Véase documentation.js,

Example: ULL-ESIT-DSI-1617/scapegoat

The Open Closed Principle and the Strategy Pattern GitHub Actions: An Introduction