Boas Práticas de Programação

Boas práticas de programação

Se você faz ou fez um curso da área de computação, já deve ter ouvido alguns desses conselhos dos seus professores.

Se é um novato que ainda está paquerando a área, certamente os ouvirá um dia.

Em todo caso, não custa repetir por aqui algumas dicas de boas práticas de programação.

Acredite, elas serão importantes na sua vida acadêmica e profissional.

Programar não é uma tarefa impossível: todo mundo é capaz com um mínimo de esforço.

Agora, programar bem são outros quinhentos, não é?

E não tem nada pior do que pegar um código confuso e/ou ineficiente.

Um bom código deve ser direto, simples e eficiente.

Se você quer melhorar suas habilidades de programação, confira algumas dicas de boas práticas de programação que podem lhe ajudar a chegar lá.

Indentação

A palavra é um neologismo, derivado do inglês indentation (recuo).

É a forma usada para organizar, visualmente, os blocos do programa com recuos (feitos com tabs ou espaços).

Com a indentação, o código fica bem mais limpo, legível e organizado.

Mas ela não serve apenas para deixar o código mais fluído.

Há linguagens como Python e Haskell que precisam da indentação para definir a hierarquia dos blocos de código, substituindo marcadores como as chaves, { }, ou palavras (begin/ end, por exemplo).

Mais um motivo para fazer uma boa indentação do código sempre.

Modularização

Para esta boa prática, vale uma regra simples: se um código ou função ocupa mais do que o espaço de uma tela, ele deve ser modularizado.

A divisão do código em funções e métodos menores, organizados em bibliotecas, classes ou pacotes – a depender da linguagem –, faz com que o código fique mais curto, organizado e, principalmente, favorece o reaproveitamento de código.

Comentários

Lembre-se que seu código, provavelmente, não ficará apenas em suas mãos.

E, mesmo que isso aconteça, se você passar um tempinho sem vê-lo, é capaz de esquecer a partir de quais passos seu algoritmo chega ao resultado esperado.

Comentar é uma arte! Claro que você não precisa comentar linha a linha, pois comentários óbvios e em excesso também atrapalham a fluidez do código.

Os comentários devem ser usados para explicar, resumidamente, o que os comandos do seu algoritmo fazem.

Servem como um guia para entendimento rápido do programa, facilitando a leitura do código.

Os comentários só aparecem para programador, certo? Pense nisso na hora da escrevê-los.

Documentação

Documentar seu projeto, descrevendo a especificação do código, é fundamental!

É a partir da análise de um arquivo bem feito de documentação que qualquer pessoa pode entender como o seu programa funciona, mesmo que não tenha acesso ao código fonte.

Clareza

Seu estilo de programação deve ser claro.

Por exemplo, escolha nomes significativos para suas variáveis e funções, faça funções pequenas que realizem uma tarefa bem definida, evite o uso de variáveis globais, modularize seu código e estabeleça interfaces claras entre os módulos.

Quem ler seu código não deve ter dificuldade para compreender o que cada trecho faz.

Padronização

Existem documentos que sugerem padrões de codificação para cada linguagem.

A padronização é uma boa prática que você deve adotar quando programar sozinho, mas que será essencial quando você participar de um projeto em grupo.

Já pensou se cada programador decide adotar um padrão? Loucura define…

Tratamento de erros e exceções

Não presuma que o usuário sempre fornecerá os dados da forma ideal ou que a máquina nunca irá se deparar com exceções.

Você precisa analisar condições de erros e exceções, prevendo-as na implementação do seu código.

Teste de mesa

Esta é uma técnica básica para testar, inicialmente, o seu código.

Funciona assim: você acompanha o fluxo de instruções e vai anotando em um papel, em sua mesa (daí o nome), os valores das variáveis.

O teste de mesa permite que você avalie se o seu programa tem algum erro de lógica.

Conheça os diferentes tipos de testes de software.

Demais testes

De nada adianta fazer um programa e não testar seu funcionamento.

Você pode começar submetendo seu programa a uma bateria de testes para ter uma ideia de como ele se comporta com diferentes tipos de entrada.

A saída é a esperada em todas as vezes?

Conheça os diferentes tipos de testes de software.

Backup

Regra de ouro: nada, nada nesta vida que envolva informática pode ser feito sem backup.

Hoje, há várias formas de salvar o seu código por aí.

Um caminho é usar plataformas de hospedagem de código fonte, como o Github e o Gitlab, que fazem, de quebra, o controle de versão dos projetos.

Acredite, isso salva vidas. Espere até “estragar” um código e querer voltar para a versão anterior…

Alguma dúvida? Mande uma mensagem!