Sobes.tech
Middle

O que, na sua opinião, significa escrever um código de qualidade?

sobes.tech IA

Resposta da IA

Clareza, legibilidade, manutenção, testabilidade, segurança, desempenho, conformidade com padrões e requisitos do projeto. O código deve ser fácil de entender por outros desenvolvedores e para fazer alterações no futuro.

Principais aspetos de código de qualidade:

  • Legibilidade: Uso de nomes significativos para variáveis, funções e classes. Formatação e indentação corretas.
  • Manutenção: Modularidade, baixo acoplamento de componentes. Duplicação mínima de código (DRY - Don't Repeat Yourself).
  • Testabilidade: Código fácil de testar automaticamente e manualmente. Inclusão de testes unitários e de integração.
  • Segurança: Proteção contra vulnerabilidades (XSS, SQL Injection, etc.). Validação de dados de entrada.
  • Desempenho: Uso eficiente de recursos (memória, CPU). Evitar "gargalos".
  • Conformidade com padrões: Seguir os padrões de codificação aceitos na equipa ou na indústria.
  • Documentação: Comentários em código complexo, documentação de API (se aplicável).

Exemplo de código limpo e legível:

# Função para calcular a área de um retângulo
def calculate_rectangle_area(width, height):
    # Verifica se os dados de entrada são positivos
    if width <= 0 or height <= 0:
        raise ValueError("A largura e a altura devem ser números positivos")
    return width * height

# Uso da função
rectangle_width = 10
rectangle_height = 5
area = calculate_rectangle_area(rectangle_width, rectangle_height)
print(f"Área do retângulo: {area}")

Exemplo de código menos limpo:

def calc_area(w, h): # Nomes abreviados e pouco claros
    if w <= 0 or h <= 0: # Sem verificação do tipo de dado
        raise ValueError("Input must be positive") # Mensagem de erro pouco informativa
    return w*h

A diferença entre os dois exemplos demonstra a importância da nomeação, legibilidade e tratamento de erros para a qualidade do código.