A programação é uma habilidade essencial no mundo moderno, e adotar boas práticas desde o início pode fazer uma grande diferença na qualidade do seu código e na eficiência do desenvolvimento.

O que são Boas Práticas?

Antes de qualquer coisa, é importante esclarecer o que são as boas práticas de programação. São diretrizes e convenções que ajudam os desenvolvedores a escrever código mais eficiente, legível e fácil de manter. Essas práticas são amplamente aceitas e recomendadas pela comunidade de desenvolvedores por promoverem a qualidade do código e facilitar a colaboração entre diferentes programadores.

Por que seguir Boas Práticas?

Pode parecer ser algo desnecessário e descartável, mas não é! Quando você adota boas práticas na hora do desenvolvimento do seu código a manutenção fica mais fácil, ajuda a prevenir erros comuns e a detectar bugs com mais facilidade. Outro exemplo, quando uma equipe segue as mesmas convenções e práticas, é mais fácil trabalhar juntos e entender o código uns dos outros, melhorando a eficiência da equipe e reduzindo o tempo gasto em revisões de código. Além de deixar o código mais legível e incentivar a modularidade e a reutilização de código, o que pode economizar tempo e esforço.

Exemplos de Boas Práticas

1. Código Limpo e Legível

Use Nomes Descritivos

Você já se deparou com um código que você não entendia nada? Usar nomes descritivos para variáveis, funções e classes facilita a compreensão do código. Evite abreviações e escolha nomes que reflitam claramente o propósito do elemento.

python

# Exemplo ruim
a = 10
b = 20
c = a + b

# Exemplo bom
num_apples = 10
num_oranges = 20
total_fruit = num_apples + num_oranges

Comente Seu Código

Quantas vezes você começou a escrever um código, mas teve que parar por alguns dias e quando voltou a continuá-lo você se perguntou "o que eu estava pensando quando escrevi isso?". Comentários são essenciais para explicar o funcionamento e o propósito do código, especialmente em trechos complexos. Porém, evite comentários óbvios e desnecessários.

python

# Exemplo ruim
x = 5 # Define x como 5

# Exemplo bom
# Calcula a área de um círculo com raio 5
radius = 5
area = 3.14 * (radius ** 2)

Organize Seu Código

Deixar o código organizado ajuda na sua leitura e compreensão, divida o código em blocos lógicos e use linhas em branco para separar esses blocos. Isso melhora a legibilidade e facilita a manutenção. Também é importante cuidar da formatação e indentação do código.

python

def calculate_area(radius):
  return 3.14 * (radius ** 2)

def main():
  radius = 5
  area = calculate_area(radius)
  print(f"A área do círculo é {area}")

if __name__ == "__main__":
  main()

2. Siga Convenções de Nomenclatura

Para quem não sabia, cada linguagem de programação tem suas próprias convenções de nomenclatura. Seguir essas convenções deixa o código mais consistente e alinhado com os padrões da comunidade.

- **Python**: Utilize `snake_case` para variáveis e funções, e `CamelCase` para classes.
- **Java**: Utilize `camelCase` para variáveis e métodos, e `CamelCase` para classes.

3. Mantenha Seu Código DRY (Don't Repeat Yourself)

Quantas vezes você já copiou e colou um trecho do seu código várias vezes? Evite duplicação de código. Se você está escrevendo o mesmo código várias vezes, considere refatorá-lo em uma função ou método reutilizável.

python

# Exemplo ruim
area1 = 3.14 * (5 ** 2)
area2 = 3.14 * (10 ** 2)

# Exemplo bom
def calculate_area(radius):
  return 3.14 * (radius ** 2)

area1 = calculate_area(5)
area2 = calculate_area(10)

4. Utilize Controle de Versão

O uso de controle de versão, como Git, é essencial para qualquer projeto de programação. Ele permite rastrear alterações, colaborar com outros desenvolvedores e reverter para versões anteriores do código se necessário.

Comandos Básicos do Git

- `git init`: Inicializa um repositório Git.
- `git add .`: Adiciona arquivos ao índice.
- `git commit -m "first commit"`: Faz um commit das mudanças.
- `git push`: Envia as mudanças para o repositório remoto.

5. Escreva Testes

Escrever testes para o seu código garante que ele funcione conforme o esperado e ajuda a identificar bugs antecipadamente. Testes unitários são uma boa prática para verificar individualmente cada unidade do código.

python

# Exemplo de teste em Python usando unittest
import unittest

def calculate_area(radius):
  return 3.14 * (radius ** 2)

class TestCalculateArea(unittest.TestCase):
  def test_area(self):
      self.assertEqual(calculate_area(5), 78.5)
      self.assertEqual(calculate_area(0), 0)

if __name__ == '__main__':
  unittest.main()

6. Documente Seu Código

Documentar o código é fundamental para que outros desenvolvedores (e você mesmo, no futuro) entendam como usar suas funções e classes. Utilize docstrings para funções e métodos.

python

def calculate_area(radius):

  """
  Calcula a área de um círculo dado o raio.   
  Args:
      radius (float): O raio do círculo.
  Returns:
      float: A área do círculo.
  """

  return 3.14 * (radius ** 2)

Conclusão

Adotar boas práticas de programação desde o início da sua jornada como desenvolvedor pode melhorar significativamente a qualidade do seu código. Essas práticas não apenas tornam o código mais limpo e legível, mas também facilitam a manutenção e colaboração em projetos maiores. A prática contínua e a revisão constante do seu próprio código são essenciais para se tornar um programador melhor.

Referências:

https://liag.ft.unicamp.br/programacao2/boas-praticas-de-programacao/

https://logap.com.br/blog/boas-praticas-programacao/

https://www.sydle.com/br/blog/clean-code-602bef23da4d09680935509b