Olá a todos da comunidade CodeGym! Hoje vamos falar sobre qualidade de código. Sim, queridos amigos. Ninguém é perfeito. Todo mundo percebe em algum momento que o código poderia ser melhor... Mas o que fazer nessa situação? No mínimo, comece a pesquisar esse problema. Mas você já está aqui, o que significa que o assunto deve lhe interessar, então vamos lá. Hoje descreveremos maneiras de tornar seu código melhor e mais limpo. Então você não terá vergonha do seu código atual no futuro! :) Todos esses métodos ajudarão um programador a se tornar um bom programador.
1. Se você quiser melhorar seu código, leia o de outra pessoa
Se você quiser melhorar drasticamente suas habilidades de programação, você precisa... ler o código escrito por outros programadores. Acredite em mim ou não. Mas se você arriscar, eu prometo: você será recompensado pelo tempo gasto. Por exemplo, não leia no medium.com sobre como funcionam HashMap, ArrayList, LinkedList, etc. Em vez disso, leia o código-fonte e descubra você mesmo. Aqui está uma lista de classes para ler:
As perguntas mais frequentes nas entrevistas são sobre o HashMap. Você pode matar dois coelhos com uma cajadada só: você entenderá o código e obterá o conhecimento de que precisa.
A mesma coisa é verdade sobre ArrayList. Não há nada complicado, mas vale a pena ler e entender o código-fonte.
String é um excelente exemplo. Entenda por que é imutável.
AtomicInteger é uma classe legal: ela define operações atômicas em objetos Integer.
Depois disso, bem, poderíamos listar todas as classes, uma após a outra :)
Falando sério, você deveria ler o código do Pivotal. O pessoal de lá escreveu o ecossistema mais procurado no mundo Java. O código deles definitivamente vale a pena ser lido. Eu recomendo que você comece com Spring Core . A leitura de código-fonte desconhecido é um trabalho difícil, mas recompensador. :)
2. Siga as convenções de código
As convenções de codificação são um conjunto de diretrizes criadas pelas equipes de desenvolvimento. Eles incluem diretrizes para estilo de codificação e técnicas para cada aspecto do código. Essas convenções podem ser escritas para toda a empresa ou para um projeto específico. As convenções de codificação são geralmente específicas para cada linguagem de programação e abrangem organização de arquivos, indentação, comentários, declarações, operadores, espaços, convenções de nomenclatura, técnicas e princípios de programação, regras de programação, práticas recomendadas para arquitetura e assim por diante. O principal benefício de certos padrões é o fato de o código ter a mesma aparência e ser escrito no mesmo estilo. Isso o torna mais legível e ajuda os programadores a entender o código escrito por outro programador. Se os padrões de codificação forem seguidos e aplicados consistentemente ao longo do processo de desenvolvimento, será mais fácil no futuro manter e estender seu código, refatorá-lo e resolver conflitos de integração. As convenções de codificação são importantes para os programadores por vários motivos:
40-80% do custo do software vai para sua manutenção,
Quase nenhum software é mantido por seu autor ao longo de sua vida,
As convenções de codificação melhoram a legibilidade do código-fonte, permitindo que os programadores entendam o novo código mais rapidamente.
Para ser honesto, sou um grande fã de padrões de codificação. Para mim, faz sentido gastar tempo discutindo e discutindo sobre eles, pois é uma atividade valiosa que economizará tempo e esforço no futuro. As convenções de código devem ser revisadas com frequência. As regras podem ser alteradas de "obrigatório" para "opcional" e vice-versa. Se alguns deles não funcionarem como esperado, eles devem ser revisados ou removidos das diretrizes.
3. Use revisões de código
Uma revisão de código é uma das ferramentas mais poderosas para melhoria de código. Por que? Porque o código será analisado pelos especialistas que não o escreveram. E um novo visual é muito útil. E uma revisão de código geralmente é o que ajuda a evitar a escrita de códigos absolutamente terríveis. Eu sei que as revisões de código nem sempre são possíveis, porque você precisa encontrar outra pessoa que esteja disposta a fazer uma. Mas isso não significa que você deva deixar de usar esta ferramenta. Muito pelo contrário: as revisões de código são um motivo para encontrar pessoas com ideias semelhantes que também precisam melhorar a qualidade de seu código. A propósito, quem vai impedir você de encontrá-los aqui no CodeGym? Em um lugar onde todos querem ser programadores.
4. Escreva testes de unidade
Minha técnica favorita para melhorar o código é definitivamente escrever testes de unidade. Quanto mais deles você escrever, melhor. Na programação de computadores, o teste de unidade é um processo de desenvolvimento de software no qual a menor parte testável do código-fonte, chamada de unidade, é testada individual e independentemente para verificar se funciona conforme o esperado. Isso o ajudará a descobrir falhas em seus algoritmos e/ou lógica antes de liberar seu código. Como o teste de unidade exige que seu código seja estruturado adequadamente, o código deve ser dividido em funções menores e mais focadas. Cada um é responsável por uma única operação em um conjunto de dados, em vez de grandes funções que executam várias operações diferentes (o princípio da responsabilidade únicaDiga Olá...). O segundo benefício de escrever um código bem testado é que você pode evitar quebrar o código ao fazer pequenas alterações na funcionalidade existente. Quando os testes de unidade falham, eles informam que algo foi escrito incorretamente. À primeira vista, o tempo de desenvolvimento gasto escrevendo testes de unidade parece um custo extra. No entanto, os testes de unidade economizarão tempo na depuração no futuro. Este deve ser um processo passo a passo. Então, vamos avançar com um sorriso — escreveremos testes para cada método e classe :D
5. Use ferramentas para melhorar a qualidade do código
Não há desenvolvedor que nunca tenha cometido um erro. Normalmente, o compilador detecta problemas de sintaxe e aritmética e exibe o rastreamento de pilha. Mas ainda podem surgir alguns problemas que o compilador não detecta. Por exemplo, requisitos implementados incorretamente, algoritmos incorretos, código estruturado incorretamente ou algum outro problema potencial que a comunidade conhece por experiência. A única maneira de detectar erros como esse é pedir a um desenvolvedor mais sênior para revisar seu código, certo? Mas essa abordagem não é uma panacéia e não mudará muito. Para cada novo desenvolvedor na equipe, você deve ter um par de olhos extra olhando para o código dele. Felizmente, existem muitas ferramentas que podem ajudá-lo a controlar a qualidade do seu código. Eu usei Checkstyle, PMD, FindBugs e SonarQube em meu trabalho em vários projetos. E há outros também. Eles são normalmente usados para analisar a qualidade do código e gerar alguns relatórios úteis. Muitas vezes, esses relatórios são publicados por servidores de integração contínua, como Jenkins.
6. Escreva um código simples e direto
Sempre escreva um código simples, compreensível e lógico. As pessoas tendem a escrever códigos complicados para provar que podem fazê-lo. Código simples e lógico sempre funciona bem, leva a menos problemas e é mais extensível. Um bom código é a melhor documentação. Se você pensa em adicionar um comentário, pergunte-se: "Como posso melhorar o código para que esse comentário não seja necessário?" —Steve McConnell.
7. Leia a documentação
Um dos hábitos mais importantes de bons programadores é ler muita documentação. Sejam suas especificações, JSRs, documentos de API, tutoriais ou qualquer outra coisa, a leitura da documentação ajuda a construir uma base sólida para sua melhor programação. Por último, mas não menos importante, não se compare aos outros. Comparar-se com os outros só levará a sentimentos negativos e competição doentia. Cada pessoa tem suas próprias forças e fraquezas. Isso significa que é importante conhecê-los e trabalhar com eles. Faça um inventário de si mesmo - liste seus pontos fortes e trabalhe neles. Programar é um verdadeiro prazer: divirta-se.
"A constante de um homem é a variável de outro homem."
8. Siga blogueiros interessantes
Milhares de entusiastas em todo o mundo trabalham e escrevem sobre as mesmas tecnologias. Os blogs geralmente são escritos pelos próprios programadores e a maioria deles compartilha opiniões e experiências pessoais. Por meio de blogs, você pode ver diferentes perspectivas sobre a mesma tecnologia. Você pode ver tecnologias boas e ruins em blogs. No mínimo, leia artigos no Coding Dojo Blog e CodeGym :) Siga bons blogs e comente as postagens, compartilhe sua opinião.
9. Leia livros sobre a profissão
Nada substitui um bom livro. Um bom livro ensina conceitos básicos de uma forma muito mais simples e se aplica às coisas do mundo real. Seus autores são grandes programadores. Ao ler livros, você pode aprender com a experiência de outra pessoa. Eu sugiro que você leia "Java Eficaz" de Joshua Bloch. Este livro apresenta setenta e oito regras práticas indispensáveis para programadores: as melhores soluções de trabalho para os problemas de programação que você enfrenta todos os dias. Ele contém as diretrizes mais práticas e confiáveis para escrever programas eficazes e bem projetados. Se você está apenas começando com Java e não tem experiência em programação, pode ler "Sams Teach Yourself Java 2 in 24 Hours". E para escrever código limpo, existe um excelente livro, "Clean Code", de Robert Martin. Depois de lê-lo,
10. Código! Código! Código!
Você não pode se tornar um bom programador apenas memorizando um livro. É fácil falar sobre conceitos teóricos. Mas você só pode aprender as limitações de um idioma ou elaborar as melhores práticas ao escrever o código. Portanto, para se tornar um bom programador, você precisa escrever muito código. Se você é iniciante, comece escrevendo programas para tarefas simples como a série de Fibonacci, palíndromos, triângulo de Pascal, etc. programas, dê uma olhada em Coding Ground . Trabalhe seu caminho através de cursos de programação e garanto que suas habilidades serão muito melhores. Outra opção é fazer o curso Harvard CS50, que é gratuito.
vamos resumir
A pessoa que não erra é aquela que não faz nada. É por isso que manejamos nossa paciência e, como um gafanhoto trabalhador, aprimoramos nossas habilidades de codificação. Para isso, não se esqueça:
Hoje vamos falar sobre qualidade de código. Sim, queridos amigos. Ninguém é perfeito. Todo mundo percebe em algum momento que o código poderia ser melhor... Mas o que fazer nessa situação? No mínimo, comece a pesquisar esse problema. Mas você já está aqui, o que significa que o assunto deve lhe interessar, então vamos lá. Hoje descreveremos maneiras de tornar seu código melhor e mais limpo. Então você não terá vergonha do seu código atual no futuro! :) Todos esses métodos ajudarão um programador a se tornar um bom programador.
As convenções de codificação são um conjunto de diretrizes criadas pelas equipes de desenvolvimento. Eles incluem diretrizes para estilo de codificação e técnicas para cada aspecto do código. Essas convenções podem ser escritas para toda a empresa ou para um projeto específico. As convenções de codificação são geralmente específicas para cada linguagem de programação e abrangem organização de arquivos, indentação, comentários, declarações, operadores, espaços, convenções de nomenclatura, técnicas e princípios de programação, regras de programação, práticas recomendadas para arquitetura e assim por diante. O principal benefício de certos padrões é o fato de o código ter a mesma aparência e ser escrito no mesmo estilo. Isso o torna mais legível e ajuda os programadores a entender o código escrito por outro programador. Se os padrões de codificação forem seguidos e aplicados consistentemente ao longo do processo de desenvolvimento, será mais fácil no futuro manter e estender seu código, refatorá-lo e resolver conflitos de integração. As convenções de codificação são importantes para os programadores por vários motivos:
Por que? Porque o código será analisado pelos especialistas que não o escreveram. E um novo visual é muito útil. E uma revisão de código geralmente é o que ajuda a evitar a escrita de códigos absolutamente terríveis. Eu sei que as revisões de código nem sempre são possíveis, porque você precisa encontrar outra pessoa que esteja disposta a fazer uma. Mas isso não significa que você deva deixar de usar esta ferramenta. Muito pelo contrário: as revisões de código são um motivo para encontrar pessoas com ideias semelhantes que também precisam melhorar a qualidade de seu código. A propósito, quem vai impedir você de encontrá-los aqui no CodeGym? Em um lugar onde todos querem ser programadores.
Sempre escreva um código simples, compreensível e lógico. As pessoas tendem a escrever códigos complicados para provar que podem fazê-lo. Código simples e lógico sempre funciona bem, leva a menos problemas e é mais extensível. Um bom código é a melhor documentação. Se você pensa em adicionar um comentário, pergunte-se: "Como posso melhorar o código para que esse comentário não seja necessário?" —Steve McConnell.
Um dos hábitos mais importantes de bons programadores é ler muita documentação. Sejam suas especificações, JSRs, documentos de API, tutoriais ou qualquer outra coisa, a leitura da documentação ajuda a construir uma base sólida para sua melhor programação. Por último, mas não menos importante, não se compare aos outros. Comparar-se com os outros só levará a sentimentos negativos e competição doentia. Cada pessoa tem suas próprias forças e fraquezas. Isso significa que é importante conhecê-los e trabalhar com eles. Faça um inventário de si mesmo - liste seus pontos fortes e trabalhe neles. Programar é um verdadeiro prazer: divirta-se.
GO TO FULL VERSION