Boas Práticas de Programação

(8 minutos de leitura) Um bom código não é somente aquele que é funcional, mas também aquele que não demanda esforço desnecessário para ser mantido. Para isso, seguem algumas dicas de boas práticas de programação

Boas Práticas de Programação

(8 minutos de leitura)


A vida de um programador não é fácil. A tecnologia é algo que não para de evoluir e a cada dia surge uma forma diferente de escrever um código. Por isso, o programador deve estar sempre se atualizando e atento às novas linguagens.

O código produzido por um profissional é de sua responsabilidade, por isso, um programador deve ter em mente que, ao programar, deve sempre fazer um “clean code”. 

Um bom código não é somente aquele que é funcional, mas também aquele que não demanda esforço desnecessário para ser mantido. A maior parte dos programadores não gosta de alterar códigos mal escritos. Isso é algo que traz muita frustração e muitas vezes um retrabalho desnecessário. Por isso as boas práticas de programação são tão importantes. 

Mas então, o que são boas práticas de programação? São um conjunto de convenções para poder tornar o código legível tanto para computadores como para humanos, com o objetivo de que sua manutenção e melhorias possam ocorrer mais facilmente. Aqui nesse texto você encontrará algumas dicas para aprimorar essas boas práticas. 


ESCREVENDO UM BOM CÓDIGO

Um clean code deve ser:

1) Simples e fácil de entender
2) Direto, sem dar voltas para atingir seu objetivo
3) Eficiente e que faz o que é proposto
4) Sem duplicar o que outra parte do código já faz
5) Elegante
6) Feito com cuidado, pois quem fez teve preocupação em produzir aquele código

Para conseguir desenvolver um clean code você precisa seguir os seguintes passos:


USAR NOMES SIGNIFICATIVOS

Seu código/método deve ter nomes que tenham algum significado em relação ao seu objetivo e esses nomes devem responder as seguintes perguntas: 

- Por que existem?
- O que fazem?
- Como são usados?

Vamos imaginar que um sistema de um motor de um carro tenha um método com o nome de “run” ao invés de “acelerar”. Se você pegar um código com esse nome você terá que estudar todo o método para saber o que ele faz.


INDENTAÇÃO

Indentação é uma palavra derivada do inglês indentation (recuo) que significa 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 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).


MODULARIZAÇÃO

Se um código ou uma função ocupa mais do que o espaço de uma tela, talvez seja uma boa ideia que ele seja modularizado.

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


FORMATAÇÃO

A formatação de um código é importante porque é parte da comunicação dele. Ninguém gostaria de receber uma carta cifrada onde tivesse que interpretar o que está escrito nela, o mesmo acontece na hora de escrever um código.

Um outro aspecto importante é que, se você pega um código bem estruturado, você vai querer mantê-lo bem estruturado. É ruim para qualquer desenvolvedor ter acesso a um código sem formatação, sem indentação e ter que fazer sua leitura como se fosse um texto sem qualquer pontuação.

Métodos com conceitos relacionados devem ficar verticalmente próximos e a ordem dos métodos deve criar um fluxo de leitura melhorando a legibilidade do código.


COMENTÁRIOS

Um código, possivelmente, não ficará apenas em suas mãos. E, mesmo que isso aconteça, depois de um tempo sem mexer nele, é provável que você se esqueça de algum detalhe para chegar ao resultado esperado.

Para evitar isso é importante usar comentários. Lógico que não é preciso exageros do tipo 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 também como um guia para entendimento rápido do programa facilitando a leitura do código.

Lembre-se que os comentários só aparecem para programador. Pense nisso na hora da escrevê-los. 


DOCUMENTAÇÃO

É fundamental documentar seu trabalho, descrevendo as especificações do código, pois é a partir da análise dessa 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 codar deve ser claro e simples. 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. Pois assim, quem ler seu código não terá dificuldade para compreender o que cada trecho faz.


PADRONIZAÇÃO

Existem alguns documentos que sugerem padrões de codificação para cada uma das linguagens.

A padronização é uma boa prática que você deve adotar quando trabalha sozinho, e é ainda mais importante quando estiver participando de um projeto em grupo.


EVITE NOTAÇÃO HÚNGARA

A notação Húngara visa facilitar o reconhecimento do tipo de variável em um programa colocando em seu nome um sufixo descrevendo seu tipo. Entretanto, com o advento de novas linguagens e testes automatizados, a notação húngara se mostra desnecessária.


TRATAMENTO DE ERROS E EXCEÇÕES

Não ache que o usuário sempre fornecerá os dados da forma perfeita ou que a máquina nunca irá se deparar com exceções. É preciso analisar condições de erros e exceções, prevendo-as na implementação do seu código.

O tratamento de erro é de responsabilidade do desenvolvedor. É necessário garantir que o código vai ter um tratamento para cada situação. Prefira lançar uma exception ao invés de retornar um código de erro. Estes retornos desorganizam a chamada do método e pode-se facilmente esquecer de verificá-los.

Dentro do seu método você já pode ver o erro que está sendo retornado e tratá-lo ali mesmo. Defina o fluxo do método separando as regras de negócio de erros ou outras situações. Para seus erros, crie mensagens informativas mencionando a operação que falhou e o tipo de falha.

Procure utilizar exception para situações inesperadas, por exemplo: seu código está lendo um arquivo e a rede se tornou indisponível.


TESTE DE MESA

O teste de mesa é uma técnica simples para testar o seu código e permite que você avalie se o seu programa tem algum erro de lógica. 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. 

Com esse teste você evite diversos erros no seu programa.


DEMAIS TESTES

Testar seu programa é essencial, pois de nada adianta fazer um código e não testar seu funcionamento. Pode começar submetendo-o a uma bateria de testes para ter uma ideia de como ele se comporta com diferentes tipos de entrada.


BACKUP

Nada nesse mundo que envolva informática pode ser feito sem backup. Existem diversas maneiras de salvar seu trabalho. Hoje um bom exemplo são as plataformas de hospedagem de código fonte, como o Github e o Gitlab, que fazem, de quebra, o controle de versão dos projetos.

Não deixe jamais de ter um backup!

É importante considerar que o código é a maneira que uma equipe de desenvolvedores vai se comunicar. Assim ele deve estar muito organizado, explicado, claro e bem estruturado, só assim o resultado do produto será o esperado pelo cliente. 


Gostou do nosso conteúdo? Então siga-nos nas redes sociais para ficar por dentro de mais informações e acompanhe o nosso blog.


Referências:
https://bit.ly/3r9MnkA
https://bit.ly/3nlNCfk
https://bit.ly/3rbRErR
Compartilhe este artigo em suas redes sociais:
Avalie este artigo:
[yasr_visitor_votes size=”medium”]

Conteúdo

Nossos artigos mais recentes

Leia sobre as últimas tendências na área de tecnologia
Blog 23-05-min
Você é apaixonado por programação e está sempre em busca de maneiras...
Blog 21-05
A tecnologia blockchain está transformando várias indústrias por meio dos aplicativos descentralizados...
Blog 16-05
Neste texto iremos falar sobre um assunto primordial na programação: o bem-estar...

Extra, extra!

Assine nossa newsletter

Fique sempre atualizado com as novidades em tecnologia, transformação digital, mercado de trabalho e oportunidades de carreira

Lorem ipsum dolor sit amet consectetur. Venenatis facilisi.