Is there a convention on how to document a JavaScript file with comments? Like function signatures, examples, etc

javascript comments document
runw picture runw · Aug 30, 2013 · Viewed 25.8k times · Source

Java has Javadoc, Python has docstring. Is there something similar in JavaScript?

Answer

Tibos picture Tibos · Aug 30, 2013

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

Related questions

What is the preferred method of commenting javascript objects & methods

I'm used to atlas where the preferred (from what I know) method is to use xml comments such as: /// <summary> /// Method to calculate distance between two points /// </summary> /// /// <param name="pointA">First point</…

Read More
How to document anonymous functions (closure) with jsdoc-toolkit

I am trying to document my code using JSDoc-toolkit. My code starts by being wrapped with a self-executing anonymous function. How in the world do I document this? I've spent nearly all day on this. JS Docs will not recognize …

Read More
How can I remove a specific item from an array?

I have an array of numbers and I'm using the .push() method to add elements to it. Is there a simple way to remove a specific element from an array? I'm looking for the equivalent of something like: array.remove(…

Read More