Skip to content

Latest commit

 

History

History
18 lines (13 loc) · 734 Bytes

tipsForJSDoc.md

File metadata and controls

18 lines (13 loc) · 734 Bytes

Para funções com parametros é necessário apontar em um comentário de JSDoc logo acima, as seguintes informações obrigatórias: nome e tipo.

A descrição é algo opcional, no entanto, bastante útil para descrever o funcionamento do código.

The @param tag provides the name, type, and description of a function parameter.

The @param tag requires you to specify the name of the parameter you are documenting. You can also include the parameter's type, enclosed in curly brackets, and a description of the parameter.

/**
 * @param {string} somebody - Somebody's name.
 */
function sayHello(somebody) {
    alert('Hello ' + somebody);
}