Definindo Nomes


Quando for definir um nome para uma Classe, método ou atributo, por exemplo, você deve escolher nomes que revelem o propósito, ou seja, você deve bater o olho e identificar o seu significado dentro do que foi escrito, e isso economiza tempo, facilita o entendimento por novos programadores e além de tudo é uma boa prática de codificação.

Se você define um nome de váriavel por exemplo e você utiliza um comentário para explicar seu significado, pode ter certeza que o nome desse atributo precisa ser alterado. Exemplo:

int d; // tempo em dias

Nesse exemplo o se olharmos apenas o nome da variável ele não diz nada e dependendo do contexto pode gerar muita confusão, pois não ajuda a revelar o seu significado dentro de um bloco de código.

Nesse caso poderia redefinir a mesma variável com um nome que condiz com o seu uso dentro do código. Exemplo:

int tempoDecorridoEmDias;

Nesse caso o nome fica mais intuitivo e facilita o entendimento de forma mais clara para quem vai fazer por exemplo uma manutenção no programa.


Referências


Livro Código Limpo de Robert C. Martin.