CodingTrain / CodingTrain/Suggestion-Box
Video request: JSDoc
Aperta
Nessuno ha ancora preso questa issue.
- Lingua principale
- Nessun dato sulla lingua
- Stelle
- 570
- Fork
- 85
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
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.
Example (Based on) :
/**
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<n; i++) {
t += arguments[i];
}
return t;
}
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Non vengono indicati file del repository, test o punti di ingresso. Inizia esaminando il sito web JSDoc collegato e l'esempio nell'issue; il lavoro sarebbe completato con un video finito che introduca JSDoc e la relativa sintassi dei commenti documentati.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- javascript
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 25/100