Olá a todos, comunidade JavaRush! Hoje falaremos sobre qualidade de código. Sim, sim, queridos amigos. Ninguém é perfeito. Todo mundo algum dia chega à conclusão de que o código poderia ser melhor... Mas o que fazer nesta situação? No mínimo, comece a pesquisar esse assunto. Já que você está aqui, significa que o assunto é interessante para você, então vamos lá. Hoje descreveremos maneiras pelas quais você pode tornar seu código melhor e mais limpo. Para que no futuro você não tenha vergonha do seu código atual!..)) Todos esses métodos ajudarão o programador a se tornar um bom programador.
1. Se você quiser melhorar seu código, leia o código de outra pessoa
Se você quiser melhorar drasticamente suas habilidades de programação, você precisa... ler código escrito por outros programadores. Você pode acreditar nisso, você não pode acreditar. Mas se você correr o risco, prometo que haverá uma recompensa pelo seu tempo. Por exemplo, não leia no Habré como HashMap, ArrayList, LinkedList e assim por diante funcionam, mas leia o código deles e descubra você mesmo. Aqui está uma lista de aulas para ler:
HashMap é a pergunta mais frequente em entrevistas. Você pode matar vários coelhos com uma cajadada só: entenda o código e obtenha o conhecimento necessário.
ArrayList é o mesmo caso do HashMap. Não há coisas complicadas aí, mas vale muito a pena ler e entender.
String é um ótimo exemplo. Entenda por que é imutável.
AtomicInteger é uma classe interessante: ela descreve o processo de como realizar operações atomicamente em objetos Integer.
E então - pelo menos todas as aulas seguidas...)
Se falarmos de algo mais sério, claro, vale a pena ler o código do Pivotal. Esses caras escreveram o ecossistema mais procurado do mundo Java. Definitivamente vale a pena ler o código deles. Portanto, aconselho você a começar pelo Spring Core . Ler código-fonte desconhecido é um trabalho desafiador, mas muito gratificante.)
2. Siga as convenções de código - convenções para escrever código
As convenções de codificação são um conjunto de diretrizes desenvolvidas por equipes de desenvolvimento que incluem diretrizes para estilo e técnicas de programação para cada aspecto do código escrito em uma empresa ou em um projeto específico. Essas convenções são normalmente específicas para cada linguagem de programação e abrangem organização de arquivos, recuo, comentários, declarações, operadores, espaços em branco, convenções de nomenclatura, técnicas e princípios de programação, regras de programação, melhores práticas de arquitetura, etc. o código parece o mesmo e é 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 de forma consistente durante todo o processo de desenvolvimento, será mais fácil manter e estender o código, refatorá-lo e resolver conflitos de integração no futuro. As convenções de codificação são importantes para os programadores por vários motivos:
40%-80% do custo do software é gasto em sua manutenção;
quase nenhum software é mantido pelo autor ao longo de sua vida;
As convenções de código melhoram a legibilidade do software, 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 lhe poupará tempo e esforço no futuro. As Convenções de Código devem ser revisadas com frequência. As regras podem ser traduzidas de “obrigatórias” para “opcionais” e vice-versa. Se alguns deles não funcionarem corretamente, precisam ser redesenhados ou removidos das diretrizes.
3. Use Code Review - revisão de código por terceiros
A revisão de código é uma das ferramentas mais poderosas para melhorar o código. Por que? Porque o código será examinado pelos especialistas que não o escreveram. E um visual novo é muito útil. E muitas vezes é a revisão de código que ajuda a evitar a escrita de códigos francamente terríveis. Sei que nem sempre isso é possível, pois é preciso encontrar outra pessoa que queira fazer isso. Mas isso não significa que não valha a pena usar esta ferramenta. Muito pelo contrário: este é um motivo para encontrar pessoas com ideias semelhantes, para quem também é importante melhorar a qualidade do código. Aliás, quem te proíbe de encontrá-los aqui no JavaRush? Em um lugar onde todos querem se tornar programadores.
4. Escreva testes unitários - testes unitários
De longe, meu método favorito para melhorar código é escrever testes unitários. Além disso, quanto mais você os escreve, melhor. Na programação de computadores, o teste unitário é 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 identificar falhas em algoritmos e/ou lógica antes de liberar o código. Como o teste unitário requer a estrutura apropriada do seu código, isso significa que o código deve ser dividido em funções menores e mais focadas. Cada um deles é responsável por uma única operação em um conjunto de dados, em vez de grandes funções executarem uma série de operações diferentes.(Como se costuma dizer, olá do Princípio da Responsabilidade Única ...) O segundo benefício de escrever código bem testado é que você pode evitar falhas futuras em pequenas alterações na funcionalidade de quebra de código existente. Quando ocorre uma falha, os testes de unidade dirão que algo foi escrito incorretamente. À primeira vista, gastar tempo escrevendo testes unitários durante o desenvolvimento parece uma despesa adicional. No entanto, isso economizará tempo no futuro, que deverá ser gasto na depuração. Este deve ser um processo passo a passo. Portanto, vá em frente e cante - escreva testes para todos os métodos e classes: D
5. Use ferramentas para melhorar a qualidade do código
Não há desenvolvedor que nunca cometa erros. Normalmente, o compilador detectará problemas de sintaxe e aritmética e gerará um rastreamento de pilha. Mas ainda pode haver alguns problemas que o compilador não detecta. Por exemplo, requisitos implementados incorretamente, algoritmos incorretos, estrutura de código incorreta ou alguns problemas potenciais conhecidos pela comunidade por experiência própria. A única maneira de detectar esses erros é pedir a algum desenvolvedor sênior para revisar seu código. Esta abordagem não é uma panacéia e muda pouco. Com cada novo desenvolvedor na equipe, você deve ter um par de olhos extra observando seu código. Mas, felizmente, existem muitas ferramentas que podem ajudá-lo a controlar a qualidade do seu código. Usei Checkstyle, PMD, FindBugs, SonarQube em meu trabalho em vários projetos. Existem outros também. Todos eles são comumente usados para análise de qualidade e geração de alguns relatórios úteis. Muitas vezes esses relatórios são publicados por servidores de integração contínua como o Jenkins.
6. Escreva um código simples e claro
Sempre escreva código simples, claro e lógico. As pessoas tendem a escrever códigos complexos para provar sua capacidade de fazê-lo. Código simples, mas lógico, sempre funciona bem, resulta em menos problemas e é mais extensível. Um bom código significa melhor documentação. Se você está pensando em adicionar um comentário, pergunte-se: “ Como posso melhorar o código para que este comentário não seja necessário? " ~Steve McConnell.
7. Leia a documentação
Um dos hábitos importantes de bons programadores é ler muita documentação. Que sejam especificações, JSR, documentos de API, tutoriais, etc. A leitura de documentos ajuda você a construir uma base sólida sobre a qual você programa melhor. Por último, mas não menos importante, não se compare com os outros. Comparar-se com os outros só levará a sentimentos negativos e a uma competição prejudicial. Todo mundo tem seus próprios pontos fortes e fracos. Portanto, é importante conhecê-los e trabalhar com eles. Analise-se, liste seus pontos fortes e trabalhe neles. Programar é muito divertido: aproveite.
“A constante de um homem é a variável de outro homem.”
8. Siga blogueiros interessantes
Existem milhares de entusiastas em todo o mundo trabalhando e escrevendo sobre as mesmas tecnologias. Os blogs costumam ser escritos pelos próprios programadores e a maioria deles compartilha opiniões e experiências pessoais. Você pode ver diferentes perspectivas da mesma tecnologia em blogs. Você pode ver tecnologias boas e ruins em blogs. No mínimo, leia artigos sobre Habré JavaRush: D, inclusive o meu. Acompanhe bons blogs e comente postagens, compartilhe sua opinião.
9. Leia livros especializados
Nada pode substituir um bom livro. Um bom livro ensinará conceitos básicos de uma forma muito mais simples e aplicará a objetos do mundo real. Seus autores são eles próprios grandes programadores. Ao ler livros, você pode aprender com as experiências de outras pessoas. Sugiro a leitura de “Java. Programação Eficaz por Joshua Bloch. Este livro apresenta setenta e oito regras práticas insubstituíveis para programadores: soluções funcionais e melhores para os problemas de programação que você enfrenta todos os dias. Ele contém as diretrizes mais práticas e confiáveis que você pode usar 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 o livro “Sams Teach Yourself Java 2 in 24 Hours”. E para escrever código limpo, existe um excelente livro “Clean Code by Robert Martin”. Depois disso, aparecerá uma “sensação de beleza” em relação ao código.
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 da linguagem ou desenvolver práticas recomendadas ao escrever código. Portanto, para se tornar um bom programador, você precisa escrever muito código. Se você é iniciante, comece escrevendo programas para problemas simples como série de Fibonacci, palíndromo, triângulo de Pascal, etc. e depois passe para problemas maiores, como árvore de pesquisa binária, etc. dê uma olhada no Coding Ground . Além disso, você pode fazer o curso CS50 , cuja tradução nos foi fornecida por “você sabe quem” :D
Vamos resumir
Quem não faz nada não comete erros. Portanto, devemos ser pacientes e, como um japonês trabalhador, aprimorar nossas habilidades de codificação. Para isso, não esqueça:
Se você quiser melhorar drasticamente suas habilidades de programação, você precisa... ler código escrito por outros programadores. Você pode acreditar nisso, você não pode acreditar. Mas se você correr o risco, prometo que haverá uma recompensa pelo seu tempo. Por exemplo, não leia no Habré como HashMap, ArrayList, LinkedList e assim por diante funcionam, mas leia o código deles e descubra você mesmo. Aqui está uma lista de aulas para ler:
As convenções de codificação são um conjunto de diretrizes desenvolvidas por equipes de desenvolvimento que incluem diretrizes para estilo e técnicas de programação para cada aspecto do código escrito em uma empresa ou em um projeto específico. Essas convenções são normalmente específicas para cada linguagem de programação e abrangem organização de arquivos, recuo, comentários, declarações, operadores, espaços em branco, convenções de nomenclatura, técnicas e princípios de programação, regras de programação, melhores práticas de arquitetura, etc. o código parece o mesmo e é 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 de forma consistente durante todo o processo de desenvolvimento, será mais fácil manter e estender o código, refatorá-lo e resolver conflitos de integração no futuro. As convenções de codificação são importantes para os programadores por vários motivos:
Por que? Porque o código será examinado pelos especialistas que não o escreveram. E um visual novo é muito útil. E muitas vezes é a revisão de código que ajuda a evitar a escrita de códigos francamente terríveis. Sei que nem sempre isso é possível, pois é preciso encontrar outra pessoa que queira fazer isso. Mas isso não significa que não valha a pena usar esta ferramenta. Muito pelo contrário: este é um motivo para encontrar pessoas com ideias semelhantes, para quem também é importante melhorar a qualidade do código. Aliás, quem te proíbe de encontrá-los aqui no JavaRush? Em um lugar onde todos querem se tornar programadores.
De longe, meu método favorito para melhorar código é escrever testes unitários. Além disso, quanto mais você os escreve, melhor. Na programação de computadores, o teste unitário é 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 identificar falhas em algoritmos e/ou lógica antes de liberar o código. Como o teste unitário requer a estrutura apropriada do seu código, isso significa que o código deve ser dividido em funções menores e mais focadas. Cada um deles é responsável por uma única operação em um conjunto de dados, em vez de grandes funções executarem uma série de operações diferentes.(Como se costuma dizer, olá do Princípio da Responsabilidade Única ...) O segundo benefício de escrever código bem testado é que você pode evitar falhas futuras em pequenas alterações na funcionalidade de quebra de código existente. Quando ocorre uma falha, os testes de unidade dirão que algo foi escrito incorretamente. À primeira vista, gastar tempo escrevendo testes unitários durante o desenvolvimento parece uma despesa adicional. No entanto, isso economizará tempo no futuro, que deverá ser gasto na depuração. Este deve ser um processo passo a passo. Portanto, vá em frente e cante - escreva testes para todos os métodos e classes: D
Não há desenvolvedor que nunca cometa erros. Normalmente, o compilador detectará problemas de sintaxe e aritmética e gerará um rastreamento de pilha. Mas ainda pode haver alguns problemas que o compilador não detecta. Por exemplo, requisitos implementados incorretamente, algoritmos incorretos, estrutura de código incorreta ou alguns problemas potenciais conhecidos pela comunidade por experiência própria. A única maneira de detectar esses erros é pedir a algum desenvolvedor sênior para revisar seu código. Esta abordagem não é uma panacéia e muda pouco. Com cada novo desenvolvedor na equipe, você deve ter um par de olhos extra observando seu código. Mas, felizmente, existem muitas ferramentas que podem ajudá-lo a controlar a qualidade do seu código. Usei Checkstyle, PMD, FindBugs, SonarQube em meu trabalho em vários projetos. Existem outros também. Todos eles são comumente usados para análise de qualidade e geração de alguns relatórios úteis. Muitas vezes esses relatórios são publicados por servidores de integração contínua como o Jenkins.
Sempre escreva código simples, claro e lógico. As pessoas tendem a escrever códigos complexos para provar sua capacidade de fazê-lo. Código simples, mas lógico, sempre funciona bem, resulta em menos problemas e é mais extensível. Um bom código significa melhor documentação. Se você está pensando em adicionar um comentário, pergunte-se: “ Como posso melhorar o código para que este comentário não seja necessário? " ~Steve McConnell.
Um dos hábitos importantes de bons programadores é ler muita documentação. Que sejam especificações, JSR, documentos de API, tutoriais, etc. A leitura de documentos ajuda você a construir uma base sólida sobre a qual você programa melhor. Por último, mas não menos importante, não se compare com os outros. Comparar-se com os outros só levará a sentimentos negativos e a uma competição prejudicial. Todo mundo tem seus próprios pontos fortes e fracos. Portanto, é importante conhecê-los e trabalhar com eles. Analise-se, liste seus pontos fortes e trabalhe neles. Programar é muito divertido: aproveite.
Existem milhares de entusiastas em todo o mundo trabalhando e escrevendo sobre as mesmas tecnologias. Os blogs costumam ser escritos pelos próprios programadores e a maioria deles compartilha opiniões e experiências pessoais. Você pode ver diferentes perspectivas da mesma tecnologia em blogs. Você pode ver tecnologias boas e ruins em blogs. No mínimo, leia artigos sobre 
Nada pode substituir um bom livro. Um bom livro ensinará conceitos básicos de uma forma muito mais simples e aplicará a objetos do mundo real. Seus autores são eles próprios grandes programadores. Ao ler livros, você pode aprender com as experiências de outras pessoas. Sugiro a leitura de “Java. Programação Eficaz por Joshua Bloch. Este livro apresenta setenta e oito regras práticas insubstituíveis para programadores: soluções funcionais e melhores para os problemas de programação que você enfrenta todos os dias. Ele contém as diretrizes mais práticas e confiáveis que você pode usar 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 o livro “Sams Teach Yourself Java 2 in 24 Hours”. E para escrever código limpo, existe um excelente livro “Clean Code by Robert Martin”. Depois disso, aparecerá uma “sensação de beleza” em relação ao código.
É fácil falar sobre conceitos teóricos. Mas você só pode aprender as limitações da linguagem ou desenvolver práticas recomendadas ao escrever código. Portanto, para se tornar um bom programador, você precisa escrever muito código. Se você é iniciante, comece escrevendo programas para problemas simples como série de Fibonacci, palíndromo, triângulo de Pascal, etc. e depois passe para problemas maiores, como árvore de pesquisa binária, etc. dê uma olhada no Coding Ground . Além disso, você pode fazer o curso CS50 , cuja tradução nos foi fornecida por “você sabe quem” :D
GO TO FULL VERSION