Código

Descrição

Aqui serão apresentadas as convenções do código desenvolvido. padrões, documentação e conceitos básicos serão alguns dos assuntos abordados.

Sumário

• Ferramentas
  • Nomenclatura de Arquivos
  • Documentação

Ferramentas de Padronização

Para garantir a padronização do projeto foi utilizado a ferramenta ESLint em conjunto com a biblioteca Husky. Estas duas bibliotecas vão realizar em conjunto a prevenção de código despadronizado no github (Husky) utilizando hooks de precommit e prepush, enquanto o ESLint garante as configurações que vamos utilizar:

• Arquivos começando com letras minúsculo e cammelCase
• Funções e variáveis com cammelCase
• Eliminação de variáveis não utilizadas
• Linhas sempre terminadas em ponto e vírgula

Nomenclatura de Arquivos

Todos arquivos seguem o padrão de cammelCase

Documentação

Para documentação de funções gerais será utilizado o padrão JSDoc Examplo:

/**
 * Esta é uma função de exemplo de uso de JSDoc
 * 
 * @example 
 *   exemplo(3, 5); // 8
 * 
 * @param   {Number} obrigatorio   Parametro obrigatório
 * @param   {Number} [opcional]    Parametro ocional. Note os '[ ]'
 * @returns {Number}
 */

Para documentação das rotas da API será utilizado swagger

Código

Variáveis e funções deverão utilizar cammelCase