Comentários - definido em 17/03/16

De MSTECH wiki
Ir para: navegação, pesquisa

Retornar para: Desenvolvimento Front-End


Definições iniciais

  • Comentário em português seguindo o padrão;
  • Nomes de funções, métodos e variáveis em inglês.


Padrão de comentário

  • @description - descrição da sua função ou do método. OBRIGATÓRIO
  • @author: nome do desenvolvedor e data de criação/alteração. OBRIGATÓRIO colocar no começo do arquivo JS quando criar ou na função quando alterar.
  • @param: descrição do parâmetro (tipo*, nome*, descrição*)
  • @callback: descrição do callback
  • @returns descrição do retorno (tipo*, nome*, descrição*).


Exemplo de comentário de método/função:

/**
 * @description Busca informações de um aluno 
 * @param {number}          _idStudent           GUID do estudante
 * @param {Function=}       _callback            Executa a função passada
 *
 * @author rodrigo.edamatsu - 02.06.16
 */
function getStudentInformation (_idStudent, _callback) {
   ...
}


IDEs de desenvolvimento

  • Visual Studio para projetos .net
  • Webstorm e/ou Atom para demais projetos


Encoding

  • Todos projetos com UTF-8