Boas práticas

O nome de uma variável, função ou classe deve responder a todas as grandes questões. Ele deve lhe dizer porque existe, o que faz e como é usado. Se um nome requer um comentário, então ele não revela seu propósito.

Exemplo:

int d; // tempo decorrido em dias

O nome d não revela nada. Ele não indica a ideia de tempo decorrido, nem de dias. Devemos escolher um nome que especifique seu uso para mensuração e a unidade usada.

int elapsedTimeInDays;

int daysSinceCreation;

int daysSinceModification;

int fileAgeInDays;

Um exemplo real de nomes que podem gerar confusão é o uso de letra "l"minúscula ou dá vogal "O" maiúscula como nome de variáveis. O problema é que eles se parecem com o um e o zero, respectivamente.

int a = 1;

if ( 0 == 1)

a = 01;

else

l = 01;

O leitor pode achar que inventamos esse exemplo, mas já vimos códigos nos quais isso acontecia bastante.