| ... | ... | @@ -15,16 +15,38 @@ Aqui serão apresentadas as convenções do código desenvolvido. padrões, docu |
|
|
|
|
|
|
|
## Ferramentas de Padronização
|
|
|
|
|
|
|
|
TBD
|
|
|
|
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
|
|
|
|
|
|
|
|
TBD
|
|
|
|
Todos arquivos seguem o padrão de cammelCase
|
|
|
|
|
|
|
|
### Documentação
|
|
|
|
|
|
|
|
TBD
|
|
|
|
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
|
|
|
|
|
|
|
|
TBD |
|
|
|
Variáveis e funções deverão utilizar cammelCase |
