Logo Questions Linux Laravel Mysql Ubuntu Git Menu
HTML CSS JAVASCRIPT SQL PYTHON PHP BOOTSTRAP JAVA JQUERY R React Kotlin
 

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

Tags:

javascript

comments

document

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

like image 783
runw Avatar asked Aug 30 '13 09:08

runw

People also ask

Is there Javadoc for JavaScript?

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.

How do you comment a function in JavaScript?

Usually, most developers use /* and */ syntax to write multi-line block comments. But the standard way to use block comments in JavaScript is to; Start with /** in a blank line. End with */ at the end line.

Are there Docstrings in JavaScript?

But that's where I was wrong — Javascript has docstrings (or its equivalent) and they're the tooltips that I love in VSCode. These guides are wonderful because they articulate the contract that you are agreeing to when you use the method or ask about the property.

1 Answers

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

like image 88
Tibos Avatar answered Sep 21 '22 19:09

Tibos
Sign in to Comment

Related questions

Is JavaScript object-oriented?
Repeating setTimeout
Getting the previous month's first date from current date in JavaScript
A question about cross-domain (subdomain) ajax request
Hide div element when screen size is smaller than a specific size
semantic-ui dropdown menu do not work
Get max and min value from array in JavaScript
Using Google Text-To-Speech in Javascript
How do I reverse the order of an array using v-for and orderBy filter in Vue JS?
Pass Array from MVC to javascript?
JavaScript Random Positive or Negative Number
How do I convert String to Number according to locale (opposite of .toLocaleString)?
fetch patch request is not allowed
Why does `obj.foo = function() { };` not assign the name `foo` to the function?
No overload matches this call. Type 'string' is not assignable to type 'Signals'
What are the cons of using a contentEditable div rather than a textarea?
What is the standard solution in JavaScript for handling big numbers (BigNum)? [closed]
Can one replace xhr.onreadystatechange with xhr.onload for AJAX calls?
Decorators on functions
Generating Javascript documentation [closed]

Donate For Us

If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!