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

Ferramentas

Lint

O Lint é uma ferramenta que analisa o código-fonte para sinalizar erros de programação, bugs, sugestões de estilos e construções suspeitas.

Basicamente o Lint irá auxiliar durante o tempo de desenvolvimento, dando sugestões para um melhor padrão de código de acordo com as regras previamente definidas.

Benefícios de utilizar

O principal objetivo do Lint é manter uma única forma de escrita, porém também ganhamos outros pontos como:

Melhor legibilidade do código: O benefício de um código mais legível é indiscutível e irá diminuir a curva de novos desenvolvedores.

Padronização do código: Com as regras bem definidas, fica fácil ter um padrão de código único.

Melhor manutenção do código: Com um padrão definido, a manutenção e refatoração serão menos dolorosas.

Ganho de tempo em code reviews: Às vezes algumas revisões demandam muito tempo e o lint pode evitar isso, pois previamente alguns ajustes poderão ser anunciados ao desenvolvedor e ele terá que corrigir.

Evitar erros: Lint também pode evitar erros em runtime, isso irá dar uma maior confiabilidade em cada linha de código inserida.

Nomenclatura de Arquivos

TDB