O objetivo deste módulo é a aplicação das primeiras técnicas de refatoração de código dando enfase nas técnicas de estilo e desing, como identação nome de variáveis e funções. Também foi definido quais ferramentas serão utilizadas no decorrer do projeto.
A identação deve ser padronizada para todo o documento. Deve também facilitar a leitura do código.
Exemplo de código mal identado:
Exemplo de código bem identado:
Deve-se dar nomes auto explicativos para todos os arquivos, classes, variáveis e funções. Esta prática reduz a necessidade de comentarios e torna o código mais auto explicativo.
Exemplo de nome ruins:
Exemplo de bons nomes:
É recomendado que todas a variáveis devem ser inicializadas no momento que são declaradas. Isso garante que não haja valores indejados nas variáveis, código como C e C++ geram valores diferentes para as variáveis cada vez que o código é rodado.
Exemplo de má iniciação de variável:
Exemplo de boa iniciação de variável
O uso de ferramentas de análise estatica ajuda a indentificar erros que o compilar não consegue reconhecer.
A ferramenta cppcheck fora escolhida para o auxilo nesta tarefa.