Desde o inicio do desenvolvimento é importante que o desenvolvedor se preocupe com a legibilidade, com o estilo e o design do código. O software deve ser escrito tendo em mente que outro desenvolvedor poderá fazer a manutenção.
Devemos ter respeito pelo próximo desenvolvedor que vai dar manutenção ou até pensar em nós mesmos, que depois de um tempo, não vamos lembrar qual a função de determinada parte do código.
Por esta razão resolvi citar algumas boas práticas de programação neste post, que podem ser seguidas para facilitar a nossa vida de desenvolvedor como de outros desenvolvedores que irão atualizar o nosso código.
1. Comentários
O comentário deve se escrito de forma que possamos entender o que o código faz, sem a necessidade de interpretar o código.Deve-se evitar comentários óbvios que vão somente poluir o código, e não vão trazer nenhum benefício para o entendimento do código.
O comentário deve ser claro de forma que após vários anos você ou outro desenvolvedor seja capaz de entender o que o código faz.
Faça os comentários conforme for codificando, porque provavelmente você não vai ter tempo de voltar para incluir o comentário e também não vai lembrar dos detalhes do código. O que pode ser óbvio agora não vai ser tão óbvio alguns dias ou semanas depois que você finalizar o código.
É preciso ter muito cuidado com a estrutura do código e com a utilização de algoritmos por exemplo, um algoritmo de ordenação que utiliza equações matemáticas, dificilmente será fácil de entender simplesmente lendo o código, por isto algoritmos devem ser muito bem comentados.
2. Consistência
Durante a escrita é necessário manter a consistência na formatação dos espaços utilizados no código. Normalmente as ferramentas de programação permitem que o desenvolvedor selecione a forma de fazer a indentação. O desenvolvedor pode escolher entre Espaços e Tabs. O correto é selecionar uma das formas e seguir esta forma durante toda a escrita do código.Se for selecionado Tab utilize somente Tab, se selecionado Espaço, utilize somente Espaço, mas nunca misture os dois, porque se utilizar as duas formas indiscriminadamente o código vai ficar desalinhado dificultando o entendimento.
3. Indentação
Na codificação o recurso de indentação deve ser utilizado para facilitar a leitura e o entendimento do código, principalmente em cláusulas com controle de fluxo, como por exemplo o IF, FOR, WHILE.A indentação facilita a leitura e entendimento das cláusulas de controle de fluxo. É bem mais fácil entender o próximo comando de uma cláusula IF, se o código estiver indentado, por exemplo, utilizando pseudocódigo. O exemplo 1 mostra um código com indentação e o exemplo 2 sem a indentação.
Exemplo 1:
Se condicao1 Entao
Execute o comando1
Senao
Execute o comando 2
Fim Se
Exemplo 2:
Se condicao1 Entao
Execute o comando1
Senao
Execute o comando 2
Fim Se
O exemplo 1 é bem mais fácil de entender do que o exemplo 2
4. Número Máximo de Linhas
Defina um número máximo de caracteres por linha de código e comentários, de modo a evitar que seja necessário utilizar o scroll horizontal para ler uma linha de código ou do comentário.5. Legibilidade
Para facilitar o entendimento das expressões utilize espaço após os operadores e vírgulas. O exemplo 1 mostra uma expressão com espaços e o exemplo 2 sem os espaços.Exemplo 1:
total_pedido = valor_objeto * qtdade
Exemplo 2:
total_pedido=valor_objeto*qtdade
O exemplo 1 é bem mais fácil de ser lido e interpretado do que o exemplo 2.
Separe blocos de código com linhas em branco para facilitar a visualização dos blocos, fazendo uma boa separação de funcionalidades de cada bloco.
Evite utilizar mais de uma declaração por linha. No momento da manutenção, sempre fica mais complicado e demorado interpretar várias declarações na mesma linha ao invés de cada linha.
6. Nomenclaturas
Ao escolher os nomes de variáveis, constantes, nomes de métodos, propriedades, selecione nomes que façam sentido dentro do contexto do software. Evite utilizar palavras ou letras que não deixam claro qual operação está sendo efetuada. Normalmente o nome deve dizer “O que” ao invés de “Como” está sendo feita a operação.Por exemplo, para fazermos uma operação de cálculo de juros, no exemplo 1 os nomes das variáveis deixam claro o que cada uma representa, no exemplo 2 não é possível saber o que está sendo multiplicado. Os nomes de variáveis devem ser descritivos.
Exemplo 1:
valor_total = valor * taxa_juros
Exemplo 2:
x = y * z
Letras podem ser utilizadas em operações como por exemplo, loops (FOR).
Alguns nomes de métodos/ funções/sub-rotinas utilizam concatenação de palavras, portanto utilize uma mistura de letras maiúsculas e minúsculas ou underscore para separar as palavras. Um bom nome para um método/função/sub-rotina que faça o cálculo de juros seria Calcula_Juros() ou CalculaJuros()
A forma de utilizar letra maiúscula ou minúscula para iniciar os nomes de métodos/funções/ sub-rotinas ou variáveis dependem dos padrões e regras de cada linguagem de programação. Por isto procure conhecer quais são os padrões e regras da linguagem em que você vai trabalhar.
Não utilizar números no meio do código que tem um significado específico. Por exemplo, se for utilizar o número 100 para definir o número máximo de itens em um pedido, ao invés de utilizar o número procure utilizar uma constante como, por exemplo NUM_MAX_ITENS_PEDIDO.
7. Organização
Faça uma divisão de métodos/sub-rotinas/funções longas ou complexas de código em módulos menores. Uma boa dica a se seguir se for possível, é que cada módulo do método/sub-rotina/função tenha no máximo o tamanho da tela do editor de textos da linguagem de programação que está sendo utilizada.Faça um arranjo ou separação do código de uma forma lógica em arquivos e pastas, de modo a ficar fácil o entendimento da estrutura em que foi projetado o código.
8. Verificações
Faça testes nos retornos de status. Por exemplo, no momento de ler ou escrever um arquivo nem sempre o programa consegue executar com sucesso, portanto teste o retorno antes de prosseguir com o restante do código.Quando ocorrerem erros deve-se procurar uma recuperação ou tratar a falha de forma graciosa, tentando continuar com a tarefa se for possível. Isto é o que programas robustos costumam fazer.
Quando ocorrer uma falha ou erro procure informar o usuário de uma forma amigável, através de mensagens com conteúdo simples, que ele possa entender qual foi o problema. Sempre é bom gravar um arquivo de log com informações que sejam úteis, para que o desenvolvedor possa entender qual foi o problema.
Procure encapsular funções construídas e bibliotecas de terceiros em seus próprios métodos, assim quando uma biblioteca de terceiro sofrer alteração não é necessário que seja revisado todo o código, e sim o método que você criou para encapsular a biblioteca. Isto também facilita o teste e debug da biblioteca, porque o código está escrito somente em um local.
Estas são apenas algumas dicas de boas práticas de programação, naturalmente existem muitas outras. Se você quiser acrescentar mais alguma dica deixe um comentário, que com certeza serão muito úteis para a comunidade de desenvolvedores.