You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Documentar o código é indispensável para qualquer projeto com muitas pessoas trabalhando e principalmente em projetos open source, pois além de facilitar as manutenções (PR's), diminui o tempo de aprendizado.
Sugiro a utilização do padrão JSDoc, segue exemplo:
/** * Represents a book. * @constructor * @param {string} title - The title of the book. * @param {string} author - The author of the book. */functionBook(title,author){}/** * Returns the sum of a and b * @param {number} a * @param {number} b * @returns {Promise} Promise object represents the sum of a and b */functionsumAsync(a,b){returnnewPromise(function(resolve,reject){resolve(a+b);});}
The text was updated successfully, but these errors were encountered:
Documentar o código é indispensável para qualquer projeto com muitas pessoas trabalhando e principalmente em projetos open source, pois além de facilitar as manutenções (PR's), diminui o tempo de aprendizado.
Sugiro a utilização do padrão JSDoc, segue exemplo:
The text was updated successfully, but these errors were encountered: