• Code quality

Regras

Rule 1.0

O código não deve possuir erros detectados pelo cppcheck.

Racional: Removendo erros detectado pelo analisador estático facilita a depuração e faz com o que projeto funcione mais rapidamente.

Rule 1.1

Somente usar variáveis globais para passar informações de uma interrupção (ISR) para a função main.

Racional: Está regra evita que você use variáveis globais onde elas poderiam ser locais.

Rule 1.2

Todas as variáveis globais acessadas de uma interrupção (ISR) devem possuir a keyword: volatile

Racional: O volatile indica para o compilador não otimizar a variável em questão que está sendo modificada por um evento gerado pelo hardware e que o compilador não tem conhecimento.

Rule 1.3

Somente as variáveis globais e modificadas durante a ISR devem ser globais.

Racional: Devemos deixar o compilador fazer o papel dele e otimizar as variáveis que devem ser otimizadas.

Rule 2.0

Todo head file (.h) deve ser criado com include guard.

Rule 2.1

Não ter implementação de código em head file (.h).

RULE 3.0

Não pode usar / gerar delay de software dentro de uma ISR.

RULE 3.1

Não pode acessar o OLED ou qualquer outro display de dentro de uma ISR.

RULE 3.2

Não pode usar printf ou sprintf de dentro de uma ISR.

RULE 3.3

Não pode executar laços de código (while, for) de dentro de uma ISR.

Racional: A ideia é que a ISR seja a mais simples e rápida possível, esse conjunto de regras evita o básico de tornar um código de ISR complexo e lento.