Nomes significativos

Os nomes estão por toda parte no software, sejam eles: arquivos, diretórios, variáveis, funções, entre outros. Por este motivo deve-se sempre criá-los com nomes significativos e que façam sentido ao que estão propostos a fazer.

Os nomes revelam as intenções do código, ou seja, escolher bons nomes que devem responder a todas as suas funcionalidades, caso haja mais de uma funcionalidade para o mesmo nome, então considere criar mais um nome para o que será feito. Basicamente, ele deve dizer por que existe, o que faz e como é usado.

Se um nome requer um comentário, então o nome não revela sua intenção.

1 - Evite usar nomes de variáveis simples demais

Um exemplo que sempre é visto em códigos são variáveis que possuem nomes simples demais, apenas com uma letra, e é muito comum encontrar da seguinte forma:

uses
  Classes, System;
          
var                         
  L: TStringList;
  I: Byte;
  
begin 
  L := TStringList.Create;  
    
  try           
    L.Add('Teste 01');
    L.Add('Teste 02');
    for I:= 0 to L.Count -1 do 
      showMessage(L[I]);      
  finally 
    L.Free;  
  end;                               
end;

O código acima poderá ser reescrito da seguinte forma:

uses
  Classes, System;
          
var                         
  vListaStr: TStringList;
  vIndice: Byte;
  
begin 
  vListaStr := TStringList.Create;  
    
  try           
    vListaStr.Add('Teste 01');
    vListaStr.Add('Teste 02');
    for vIndice:= 0 to vListaStr.Count -1 do 
      showMessage(vListaStr[vIndice]);      
  finally 
    vListaStr.Free;  
  end;                               
end;

2 - Nomes de métodos

Os métodos devem ter nomes de verbos ou frases verbais como RealizarPagamento, DeletarPagina ou Salvar.

No caso dos métodos que acessam alguma informação ou buscam informações devem ser nomeados por seus valores e prefixados com get ou set.

3 - Use nomes de domínio de solução

Lembre-se de que as pessoas que lerão seu código serão programadores. Portanto, vá em frente e use termos de ciência da computação (CS), nomes de algoritmos, nomes de padrões, termos matemáticos e assim por diante.