Tópico 01 - Introdução ao Código Limpo

A crise do software

Em 1968, a OTAN (Organização do Tratado do Atlântico Norte) criou um projeto para discutir e implementar padrões de desenvolvimento e especificar, pela primeira vez, o termo Engenharia de Software

Aumento da demanda e da complexidade

Demanda crescente de novos softwares, impulsionada pelo estabelecimento de novas redes de computadores

Mesmos métodos e força de trabalho

Necessidade de criar novos métodos e ferramentas de desenvolvimento que suportassem a demanda

Caso Therac-25

Na década de 80, a Atomic Energy of Canada Limited (AECL) desenvolveu uma série de máquinas de radioterapia chamadas Therac

6 mortes entre 1985 e 1987

Falhas de Software

• Design ruim
• Sem testes
• Sem mensagens de erro
• Excesso de confiança

Caso Ariane 5

Em 1996, o foguete Ariane 5 explodiu após 39 segundos de voo e causou um prejuízo de 370 milhões de dólares.

Causa: Overflow

O sistema do foguete tentava converter uma variável de 64 bits em uma de 16 bits, resultando em um overflow do resultado em tempo de execução.

Que outras falhas poderiam ser evitadas?

Como evitar falhas?

• Desenvolvimento Ágil
• Testes Automatizados
• Revisão de Código
• Arquitetura Limpa
• Programação Defensiva

Impactos do Código Limpo

• Redução de custos
• Maior produtividade
• Menos vulnerabilidades
• Mais facilidade na manutenção
• Escalabilidade de equipes

Código Limpo

O que faz um código ser considerado limpo?

• Legível (Readability)
• Mantenível (Maintainability)
• Testável (Testability)
• Extensível (Extensibility)
• Elegante (Beauty)

Barreiras do Código Limpo

O que faz algum programador não escrever código limpo?

• Ignorância
• Teimosia
• Arrogância
• Falta de Tempo

É sua responsabilidade como programador defender seu código

Robert C. Martin

Débito Técnico

O Débito Técnico é o resultado de uma implementação sem planejamento, mas que é adicionado para atender a uma demanda imediata.

Com o tempo, o débito técnico se acumula e pode levar a problemas de performance, segurança e escalabilidade.

Analogia do Débito Bancário

O Débito Técnico é como um empréstimo bancário. Você pode pegar um empréstimo para comprar algo que precisa agora, mas terá que pagar juros no futuro.

O débito técnico as vezes compensa?

Clean Code e LLMs

Sem o devido contexto, LLMs não conseguem inferir a intenção do código. Por isso, é importante escrever código limpo para que as LLMs possam entender e ajudar a melhorar o código.

Considere:

double calc(double a, double b)

Melhorando o contexto para LLMs

double calculateFinalPrice(double productPrice, double taxRate)

A segunda versão dá ao modelo:

• Contexto de domínio
• Intenção do código
• Significado dos parâmetros

Estudos científicos sobre o impacto do código limpo em LLMs

Clean Code, Better Models: Enhancing LLM Performance with Smell-Cleaned Dataset

• Qualidade do código de entrada (com code smells) afeta fortemente o desempenho dos LLMs.
• Criação da ferramenta SmellCC (baseada em LLM) para remover code smells e validar em 50 repositórios.
• Resultados: 91,6% dos code smells removidos em todo o CodeSearchNet-Python, 96,8% de remoção com 91,3% de correção em 50 repositórios, e ganhos de até 12,2% em code completion e *4,3% em code search com dados limpos.

Práticas de Código Limpo

Livro escrito por Robert C. Martin cunhou o termo Código Limpo.

É uma referência e não um dogma.

Nomenclaturas

Existem apenas duas coisas difíceis em ciências da computação: Invalidação de cache e dar nome as coisas - Phil Karlton, Netscape developer

Funções e Comentários

Uma função bem escrita vale mais do que mil comentários. Um comentário pode mal escrito pode valer por uma função mal escrita.

Formatação e Estrutura

Grandes empresas de software possuem padrões de formatação de código.

• Google Java Style Guide

Tratamento de Erros

O primeiro bug de software registrado foi, literalmente, um inseto preso em um computador em 1947, documentado por Grace Hopper.

Estruturas de Dados

Qual a melhor estrutura de dados para abstração de um problema?

Escrever código limpo é uma arte, não uma ciência.

Material de Apoio

• Clean Code (PT/EN)
• Clean Code, Better Models: Enhancing LLM Performance with Smell-Cleaned Dataset
• As falhas numéricas que podem causar desastres