CodingTrain / CodingTrain/Suggestion-Box

Video request: JSDoc

Open
#1,078 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
No language data
Stars
570
Forks
85
PR merge metrics
No merged PRs in 30d

Description

Hi Daniel,

it would be really cool if you could do a video about JSDoc. If you don't know it's a tool which let's you create a documentation of your JS project just by adding well formatted comments before variables and functions.

[The JSDoc website](http://usejsdoc.org/)

Example ([Based on](http://usejsdoc.org/tags-type.html)) :

```js
/**
Returns the sum of all numbers passed to the function.
@param {...number} num A positive or negative number
@returns {number} The sum
*/
function sum(num) {
var i=0, n=arguments.length, t=0;
for (; i

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.