Código limpo na programação

 

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

Comentar o seu código é bom até certo ponto. Bom quando para explicar uma lógica um pouco complexa dependente de um conhecimento prévio da funcionalidade, e péssimo quando adicionado para cada linha do código. Um código com tanto comentário parece mais um tutorial, ótimo para ensinar e péssimo para dar 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:

 

Página html misturadoo com estilo e javascript com mais de 200 linhas
Estilo, JS, HTML juntos na página com mais de 200 linhas

 

Código limpo na programação, página html referenciando arquivo js, arquivo css e arquivo json
Código separado em CSS (62 linhas), JS (62 linhas), JSON (77 linhas) e HTML (17 linhas)

 

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

Deixe um comentário

O seu endereço de e-mail não será publicado. Campos obrigatórios são marcados com *