NPN328
Reputation: 1942
Is there a convention on how to document a JavaScript file with comments? Like function signatures, examples, etc
Java has Javadoc, Python has docstring. Is there something similar in JavaScript?
Upvotes: 62
Views: 31780
Answers (1)
Tibos
Reputation: 27823
The most commonly used is JsDoc (https://jsdoc.app/).
This is also a tool that generates documentation from your sources, commented with JsDoc style: https://github.com/jsdoc3/jsdoc
Upvotes: 54
Related Questions
- How should I comment object structure in JavaScript?
- Typescript: Are there any conventions to document code with comments?
- What is the correct way of code comments in JavaScript
- Is there a convention for specifying the author, date, or source of code in JavaScript?
- commenting callback functions
- Commenting JavaScript functions á la Python Docstrings
- Javascript commenting practice
- Do JavaScript Style Comments Have to Go Between Script Tags?
- Which comments documentation format is better for JavaScript?
- javascript comments and documentations