A importância de um código limpo na programação se tornará evidente no momento de sua manutenção / atualização. O próprio desenvolvedor após alguns meses terá, dependendo da situação do código, dificuldades de se encontrar dentro das funcionalidades.

Comentários no código: equilíbrio entre clareza e excesso

Adicionar comentários ao código é uma prática útil, mas deve ser feita com critério. Eles são fundamentais para explicar lógicas mais complexas que exigem conhecimento prévio da funcionalidade. No entanto, inserir comentários em cada linha pode tornar o código mais um tutorial do que um documento de fácil manutenção. Um excesso de explicações desnecessárias polui o código e dificulta futuras alterações, tornando a leitura menos fluida. O ideal é encontrar um equilíbrio: comentar o que realmente ajuda na compreensão e evitar redundâncias que não agregam valor à manutenção.

 

Loops

Trabalhando com listas, vetores ou matrizes que na maioria das vezes é necessário utilizar loops para interagir com seus valores, uma ótima ideia seria reduzir a quantidade de loops nesta lista. Se é necessário rodar todos os valores desta lista, o código será mais performático se esse procedimento acontecer o mínimo de vezes possível. São poucas as vezes em que realmente é necessário rodar a mesma lista mais de 1 vez.

Quando pensar em criar um loop para rodar os valores de uma lista, verifique no seu código se já não rodou estes mesmos valores antes, e se já, coloque a nova funcionalidade neste loop existente.

 

Nomes de Funções e Variáveis

Ao nomear as suas variáveis e funções (eu falho muito nesta parte) é mais produtivo identificá-las por sua utilização, mesmo sendo tentador criar variáveis do tipo: i, j, h, aux, x etc… Quando o código ganhar volume, ter um nome mais elucidativo, evitará as várias rolagens de tela para verificar que variável é aquela e onde foi utilizada.

O nome da variável não pode também, chegar ao tamanho de uma frase, pois o que facilitaria no reconhecimento dela, dificultará o entendimento do código por causa da poluição visual de tanto texto na tela. A mesma situação se aplica as funções.

 

Cada um no seu quadrado

Em desenvolvimento WEB quando a proposta é uma simples página com poucas funcionalidades, não é tão necessário separar estilos, scripts e HTML, mas quando você precisa dar mais de 3 PAGE UPs ou PAGE DOWNs, fica muito mais produtivo separar a sua página em: regras de estilo arquivo CSS, códigos script arquivo JS e manter apenas a codificação HTML no arquivo da página.

Se o script for muito complexo, talvez seja necessário separar em mais JSs classificando-os pelo objeto das funções. Ex.: tabela.js, menu.js, carrosel.js etc.

Segue abaixo um exemplo de página com código todo junto, e a mesma página com o código separado:

 

 

 

Saiba mais sobre código limpo na programação nesta playlist do youtube!