Como escrever um bom código?

Ao longo do desenvolvimento de qualquer projeto, os scripts vão evoluindo, recebendo alterações e correções de erros e quando você menos espera, tudo aquilo virou um monstro e basta um final de semana longe do seu código que já surgem dúvidas do tipo: o que essa função faz mesmo? E para que eu criei essa variável, Jesus?

Utilizar ferramentas de controle de versão dá mais tranquilidade e facilita a organização do trabalho em equipe ou até mesmo individual. Além disso em códigos de computador é muito comum fazer uma alteração trivial e misteriosamente todo o código se comporta de maneira inesperada depois, por isso é relevante ter a possibilidade de voltar a versões anteriores.

Comentários no código também são importantíssimos, já que outras pessoas podem precisar trabalhar com a sua obra prima.

Você pode armazenar seu código utilizando alguma das ferramentas abaixo:

Existem uma série de ferramentas no mercado, que nos auxiliam a guardar e manter as nossas versões. Podemos utilizar alguns repositórios:

  • Github: Ferramenta de controle de versão mais comumente utilizada. Permite compartilhar projetos com visibilidade pública de maneira gratuita e oferece uma versão paga com controle privado de acesso ao código. Veja aqui um guia prático de uso do Github.
    – Bitbucket: Veja aqui um guia prático de uso do Bitbucket.
  • GitLab: Ferramenta muito parecida com o github, com a vantagem de permitir que seu código fique privado gratuitamente.

Dicas

  1. Escreva seu código para pessoas, não para computadores: Um programa de computador por mais complexo que seja, não deve ser difícil de ser entendido, utilize nomes realmente significativos em suas variáveis,classes e funções, evite utilizar nomes como aux, x1 ou valor, pois não transmitem significado ao leitor do código.
  2. Faça mudanças incrementais: A cada nova versão documente as alterações e utilize uma ferramenta de controle de versão para garantir a rastreabilidade do seu código. Faça pequenas alterações no código e registre cada uma com máximo de informações possíveis na descrição.
  3. Evite Repetições: Sempre que possível divida seu código em funções específicas que façam apenas uma tarefa, desta forma seu código fica modularizado e eficiente.Caso precise realizar aquela função novamente basta chamar a função já criada, isto evita repetições desnecessárias e melhora a qualidade do seu código
  4. Tenho um arquivo Readme associado a seu projeto: Mesmo que você tenha organizado as pastas, os dados e todas as informações da melhor maneira possível. Ofereça no arquivo Readme uma documentação com uma visão geral do projeto além de dar informações sobre cada pasta. Não se esqueça de manter seu arquivo Readme atualizado a medida que o projeto vai sendo modificado.
  5. Cuide da organização dos arquivos e diretórios. Apenas como sugestão as pastas podem ser organizados da seguinte maneira:
  • data: Armazena os dados utilizados no projeto.
  • dev: Armazena os scripts e funções do projeto.
  • figures: Armazena as imagens utilizadas para ilustrar o projeto.
  • Readme: Exibe uma visão geral do projeto em forma de texto, detalhando as principais features.

6. A cada commit faça um comentário da alteração realizada. Dessa forma todos que consultarem seu repositório terão uma pista da alteração realizada naquele ponto.

Caso este texto tenha sido útil, deixe o seu comentário contando a sua experiência! 🙂

Leia também

Deixe uma resposta

O seu endereço de e-mail não será publicado.