Home	Escopo e Cronograma	Processo	Design/Mockups	Configuração	Arquitetura	Código	Banco de Dados	Qualidade

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

No final do projeto foi adicionado a ferramenta de checagem de código lint no backend, tornando padronizado o código conforme boas práticas de desenvolvimento.

Nomenclatura de Arquivos

No inicio do projeto, foi definido que o idioma das variáveis, nomes de métodos e classes seriam completamente em inglês. Além disso, no backend as classes possuem como sufixo, o nome do pacote ao qual pertencem.

Documentação

Para documentar o projeto, utilizamos esta wiki, o README em cada repositório, bem como swagger, no banckend, para a documentação viva das rotas.