Skip to content

Repository for the Software Engineering course. The goal of this activity is to refactor legacy code by applying Clean Code principles.

Notifications You must be signed in to change notification settings

imnatalia/refactor-code

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Refatoração de Código - Engenharia de Software

Repositório para a disciplina de Engenharia de Software. O objetivo desta atividade é refatorar um código legado, aplicando princípios de Código Limpo (Clean Code) para melhorar sua qualidade, legibilidade e manutenibilidade.

📝 Sobre o Projeto

O projeto consiste em analisar um código-fonte preexistente que não segue boas práticas de desenvolvimento e aplicar uma série de refatorações para adequá-lo aos padrões de qualidade de software. A ideia é demonstrar na prática como os conceitos de Código Limpo podem transformar um código difícil de entender e manter em um software mais robusto e claro.

🎯 Objetivo

O principal objetivo é aplicar técnicas de refatoração para resolver "code smells" (maus cheiros no código), como:

  • Nomes de variáveis e métodos pouco descritivos.
  • Métodos muito longos e com múltiplas responsabilidades.
  • Uso de "números mágicos" e valores constantes espalhados pelo código.
  • Comentários desnecessários ou que poderiam ser substituídos por um código mais claro.
  • Duplicação de código.

✨ Princípios de Código Limpo Aplicados

Durante a refatoração, foram aplicados os seguintes princípios de Clean Code:

  1. Nomes Significativos: Variáveis, métodos e classes foram renomeados para expressar claramente seu propósito.
  2. Funções Pequenas e com Responsabilidade Única: Funções longas foram quebradas em métodos menores e mais focados, seguindo o Princípio da Responsabilidade Única (SRP).
  3. Extrair Constantes: "Números mágicos" e strings literais foram substituídos por constantes nomeadas, melhorando a legibilidade e facilitando futuras manutenções.
  4. Evitar Comentários Desnecessários: O código foi reescrito para ser autoexplicativo, removendo comentários que apenas repetiam o que o código já dizia.
  5. Formatação e Clareza: O código foi reformatado para seguir um padrão consistente, melhorando a legibilidade geral.

Este repositório serve como um estudo de caso prático sobre a importância da qualidade de código no ciclo de vida do desenvolvimento de software.

About

Repository for the Software Engineering course. The goal of this activity is to refactor legacy code by applying Clean Code principles.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published