Sete dicas para melhorar a escrita de código

Todo desenvolvedor sonha em ficar melhor na escrita de código. Ele / ela quer que o código seja limpo e pragmático. Mas isso não acontece por conta própria. Aqui estão algumas dicas para melhorar a escrita de código:

  • Siga o TDD: o desenvolvimento orientado a testes é uma ótima maneira de melhorar o código. Isso garante que a funcionalidade que você implementa está fazendo o que deveria. Certifique-se de passar algum tempo escrevendo testes antes de escrever um recurso. É uma prática difícil de inculcar na sua equipe, mas acredite em mim, a quantidade de tempo e estresse que você economizará por causa disso é fenomenal. Basicamente, existem dois tipos de testes que devem estar presentes com seu código:

Testes unitários e testes de integração. Ambos são igualmente importantes. Às vezes, pode não ser possível fazer com que todas as unidades sejam testadas, mas certifique-se de que as partes principais tenham testes de unidades e os testes de integração sejam concluídos.

  • Escreva mensagens de commit boas e detalhadas: Eu não posso recomendar este o suficiente. Desde que conheci essa prática, pude sentir facilmente a melhoria em meu código. Eu prefiro escrever longos comentários no meu código. Sempre que você fez algo que precisa ser explicado ou se você fez um hack para resolver algum problema particular, certifique-se de abordar essas partes em sua mensagem de commit. Isso realmente ajuda porque sempre que sua base de código fica maior. Um novo desenvolvedor pode simplesmente dar uma olhada no código e enviar a mensagem. Ele se sentirá mais confortável para começar a trabalhar. Além disso, se você estiver trabalhando em um projeto de código-fonte aberto e seguir esta prática, as chances são muito altas de que sua solicitação pull seja mesclada. Uma razão para isso é que a pessoa que está mesclando seu código não terá que mergulhar fundo em seu código para entender o que você fez lá. Sua ‘mensagem de confirmação detalhada’ servirá ao seu propósito então. Embora suas mensagens de commit não devam se transformar em documentação do projeto: embora você deva colocar um resumo e uma pequena lista de coisas que você mudou em um commit, longas explicações sobre algoritmos, estrutura de dados e arquitetura geral do projeto devem permanecer e ser mantidas no wiki do projeto ( ou qualquer ferramenta que você usa para documentação interna).

  • Aprenda a escrever código sustentável: sempre, tente pensar em escrever código sustentável. Pode não ser sempre possível devido aos prazos. Mas faça questão de revisitar esse código e consertar aquele hackery que você fez lá. Isso é muito importante, porque, mais cedo ou mais tarde, esse hackery / bug virá para mordê-lo e as coisas podem ficar realmente feias.

  • Conheça o seu editor: você deve e deve configurar o seu editor para a linguagem do seu código. Ele deve ter todos os plug-ins necessários para fazer live linting. Se você faz python ou JS, existem alguns plug-ins muito bons disponíveis para as linguagens do Vim e do Sublime Text2. Além disso, familiarize-se com alguns bons snippets geradores de plug-ins para frameworks, HTML e CSS. Existem ótimos plug-ins para embelezar e minimizar seu código também. Eles realmente ajudam a melhorar toda a qualidade do código.

  • Automatize todas as tarefas repetitivas: neste momento, estamos praticamente equipados com as tecnologias como grunt e yeoman, que podem automatizar muitas partes que você precisa perder seu tempo fazendo repetidas vezes. Você também deve aprender sobre git hooks. Por exemplo: Eu fiz um gancho pré-commit do git para compilar menos em css e executar as operações jshint, concat e uglify no meu código JavaScript sempre que houver alguma mudança. Isso é incrível porque meu fluxo de trabalho impede que qualquer código ruim entre na base de código.

  • Leia bons códigos, estruturas de dados e algoritmos: não há fim para o aprendizado. Aprenda a ler cada vez mais códigos bons. Você deve gastar tempo melhorando as estruturas de dados e algoritmos. Eles podem não ser úteis imediatamente, mas farão de você um desenvolvedor melhor e permitirá que você tome melhores decisões no futuro.

  • Assista a palestras e apresentações: assista regularmente a ótimas palestras e apresentações de várias conferências ao longo do ano. Eles fornecem algumas informações muito boas sobre as últimas tendências e técnicas. Você pode encontrá-los facilmente no YouTube / Vimeo e no SpeakerDeck.

Cenário

Para postagens de blog mais interessantes, visite http://www.gotchacode.com

Edit: Obrigado dpashkevich por suas ótimas observações sobre mensagens de commit. Adicionados à seção de mensagens de commit.