Código Limpo: desenvolva um bom código de uma vez por todas!

Você já deve ter ouvido falar no livro Clean Code escrito por Robert Martin, certo? O livro descreve como desenvolver um “código limpo” e sobre alguns impactos de não fazê-lo. Caso já tenha lido o livro dá uma lida nesse post para refrescar a memória, senão venha acompanhar algumas dicas para parar de dar desculpas e desenvolver um bom código de uma vez por todas!

Apesar de talvez não conhecer todas as técnicas de desenvolvimento utilizadas para produzir um bom código, todos os desenvolvedores têm ideia de como fazê-lo. Porém, na maioria dos casos nos sabotamos e costumamos usar pelo menos uma das desculpas abaixo:

  • “O prazo do projeto é muito agressivo.”
  • “Pulando essas etapas faço em menos tempo.”
  • “O cliente deseja receber isso pra ontem.”
  • “Estou sendo pressionado, preciso acabar logo.”

Após nos iludirmos com uma dessas justificativas sempre combinamos de voltar ao código num momento oportuno para realizar algumas alterações. O problema é que esse dia nunca chega! Os prazos vão continuar agressivos, os clientes continuarão aguardando e a pressão vai permanecer. O dia de mudar os hábitos e prezar pela qualidade de desenvolvimento é hoje!

Caso você ainda não esteja convencido de mudar alguns velhos hábitos e investir na qualidade, vou listar algumas razões para repensar os impactos disso.

  • Seu nome estará gravado no controle de versão, e você será lembrado pelo bom (ou mau) trabalho que realiza.
  • Desenvolvemos códigos para pessoas, quando o código é mal escrito é difícil de ser entendido pelos outros.
  • Um código ruim ou complexo precisa ser explicado para outras pessoas gerando desperdício de tempo.
  • Código ruim custa caro! Difícil de entender, manter, alterar e por aí vai.

Depois de perceber os impactos talvez você deseje nunca ter desenvolvido um código ruim. Afinal, o que é um código ruim?

Inflexível: Não é passível de alteração, ou causa grandes impactos ao ser alterado.

Não-Reutilizável: Não é possível aproveitar partes do código em mais de um lugar.

Opaco: O nome dos objetos, classes, métodos, funções e variáveis não deixam claro sua função.

Em contrapartida, o código limpo é:

  • “Elegante e eficiente. Código limpo faz bem uma coisa.” Bjarne Stroustrup
  • “Cada rotina que você lê faz o que você espera.” Ward Cunningham
  • “Parece ter sido escrito por alguém que se importa.” Michael Feathers

Confira abaixo algumas das técnicas para produzir código limpo:

Nomenclatura

Aplica-se aos métodos, classes, variáveis, funções, procedimentos e afins.

  • Deve revelar sua intenção/finalidade.
  • Deve ser pronunciável.
  • Deve ser possível encontrar no código sem muito esforço.

Formatação

  • Sempre deve ser identado.
  • Deve agrupar códigos por assunto/funcionalidade.
  • A linha de código deve caber na tela (sugestão de 120 caracteres).
  • Deve seguir o padrão de codificação da equipe.

Funções

  • Devem ter uma única finalidade.
  • Devem ser identadas no máximo ao nível 2.
  • Devem possuir o menor número de parâmetros possível.
  • Não devem possuir duplicidade de código.

Classes

  • Quanto menor o código melhor.
  • Deve possuir declarações de variáveis e métodos organizadas.
  • Deve seguir o Princípio de Responsabilidade Única (fazer somente uma coisa, e fazê-la bem).

Parece muito simples, não acha? Coloque em prática as técnicas do Clean Code e torne-se um programador cada vez melhor!

Caso se depare com códigos ruins, que tal aplicar o refactoring? Afinal, não basta escrever um código bom, é necessário mantê-lo.

Referência

Clean Code, Robert C. Martin

Por KARINA COSTA MINEIRO

Analista de Sistemas, motivada por desafios, adepta ao desenvolvimento Ágil! Ama filmes e séries, louca por cachorros e entusiasta DIY.

Postado em: 17 de janeiro de 2017

Confira outros artigos do nosso blog

Copa do Mundo: Integrando planilha Google com uma aplicação Firebase

19 de junho de 2018

Flavia Domingues

Como funciona a Blockchain?

11 de junho de 2018

Alan Cesar Elias

Tutorial: Carga de dados com o SQL Loader

17 de abril de 2018

Ricardo Silveira

Aprendendo Spring Framework

09 de abril de 2018

Hivison Moura

Deixe seu comentário