Como escrever código bom e claro: 3 maneiras fáceis para um programador



De um tradutor: hoje estamos publicando para você um artigo de um desenvolvedor indiano Ravi Shankar Rahan. Ele fala sobre o que fazer se você quiser aprender a escrever código simples e compreensível. O artigo é recomendado a todos os programadores iniciantes.

Escrever um código simples é fácil. Mas se estamos falando de prepará-lo para uso futuro por alguém, tudo se tornará complicado imediatamente. O fato é que esse código deve ser ainda mais limpo e compreensível.

O desenvolvedor precisa criar um código que possa ser usado por qualquer um de seus colegas de qualquer país do mundo. Então ele se torna algo como sua "herança". Tudo isso parece bom e dobrável, mas a realidade é um pouco diferente ...

A Skillbox recomenda: Curso prático de dois anos "Eu sou um desenvolvedor Web PRO" .

Lembramos que: para todos os leitores de "Habr" - um desconto de 10.000 rublos ao se inscrever em qualquer curso Skillbox usando o código promocional "Habr".

O fato é que, no início da minha jornada, mesmo aceitando o dogma acima, criei um código tão monstruoso que não poderia ser chamado de "bom". Era quase impossível entender e interpretar. Um pouco mais tarde, comecei a passar dias e meses na “correção” e “revitalização” dos monstros que criei.

É difícil de programar. Quando você escreve um programa no qual existem linhas de linhas, comete erros. Algumas vezes são significativas, outras não muito. Mas, independentemente do tamanho, leva tempo para encontrá-los e corrigi-los. Às vezes, você precisa de ajuda para sair do funil de desespero e desesperança em que se enquadra ao trabalhar no seu código.

Às vezes você precisa ... de um pato de borracha

O conceito do pato de borracha foi proposto pela primeira vez por Dean Parker em seu posto no oratório. Parker diz que, para se tornar um bom orador, você precisa praticar constantemente discursos. E a melhor maneira de se livrar do medo do público enquanto aprende a expressar seus pensamentos de maneira concisa e inteligível é falar durante os "treinamentos de oratória" antes do pato de borracha. Ela apenas substitui a platéia.

Como programador, você precisa tentar explicar todas as linhas do seu código para um pato de borracha (real ou imaginário). Ao tentar fazer isso, você começa a entender os pontos fortes e fracos do código. Você se dá a oportunidade de olhá-lo de lado.

Aqui estão alguns pontos importantes que percebi ao aplicar essa prática. Eles me ajudaram a começar a escrever notavelmente melhor.

Criar componentes reutilizáveis ​​não é uma necessidade permanente

Muitos discordam de mim, argumentando que os componentes reutilizáveis ​​são sempre necessários, que precisam ser reutilizados o mais rápido possível. Digamos, isso ajuda a melhorar a qualidade do código e a trabalhar com seus próprios erros. Isso mesmo, mas apenas se você criar o melhor código do mundo. E ninguém precisa dele.

Não é claro. Você precisa criar um software que atenda a certas condições, incluindo orçamento. Você também pode polir constantemente seu projeto, trazê-lo a brilhar, perdendo tempo, mas se sentindo como um desenvolvedor ideal. Mas lembre-se: o software é relevante por um tempo limitado, o que significa que você precisa trabalhar rapidamente, caso contrário, nunca terminará.

Você não vai precisar disso

O axioma inglês original soa como "YouArentGonnaNeedIt (YAGNI)". Você deve entender o seguinte: "Use determinadas ferramentas somente quando realmente precisar delas, e não pense que elas podem ser úteis para você".

Há duas razões para isso:
  • Você economiza tempo evitando trabalho desnecessário.
  • Seu código fica melhor à medida que você o salva dos "supostos" elementos que complicariam o programa.

Simplifique tudo ao mínimo

A programação extrema tem duas regras de ouro para a criação de código simples.

Primeiro , a maneira mais fácil de introduzir um novo recurso é fazê-lo "apenas funcionar". Não há necessidade de criar superestruturas chiques, algo de alta tecnologia. Apenas faça a função funcionar. Mas não esqueça que o código deve passar nos testes de unidade.

Em segundo lugar , refatorar o sistema para que o código se torne o mais simples possível, com a inclusão de todas as funções atuais. Deve ser o mais limpo possível.

Em terceiro lugar , vale a pena aprender que não estamos procurando o caminho mais rápido. Nós nos esforçamos para alcançar o resultado mais simples (em termos de código). Por exemplo, você pode dividir um método existente em partes, o que deixará os fragmentos de teste funcionando e, em seguida, modificar cada um dos métodos de processamento, passo a passo.

Quando você ficar preso na próxima vez, tente pato

Encontrar bugs, problemas, trabalhos gerais sobre código é a parte principal da programação. Portanto, o desenvolvimento de nossas próprias técnicas para pesquisar e eliminar bugs, encontrar o caminho é uma tarefa crítica.

Se você estiver preso em algum lugar e nada funcionar, tente se esquivar.

Você não pode imaginar, mas compre. E não importa se é um pato comum para uma banheira ou um pato pirata - o principal é que você se sinta confortável com ele para que ele corresponda à sua personalidade.

E depois disso, você pode iniciar uma conversa com um pato. Converse com ela, faça perguntas, explique em voz alta o problema com o qual está trabalhando. O resultado irá surpreendê-lo.

Chris Pine estava certo ao dizer: "Programação não é o que você sabe, é o que você pode aprender."

Source: https://habr.com/ru/post/pt434304/


All Articles