No internet connection
  1. Home
  2. Dúvidas Gerais

CLEAN CODE: Boas Práticas de Programação?

Por Hebert Almeida Rocha @HebertRocha
    2023-01-11 12:38:27.817Z

    Livro sobre Clean Code

    Já vou começar este artigo indicando o livro: “Clean Code: A Handbook of Agile Software Craftsmanship” estou indicando mesmo sem ler kkkkk, mas já ouvi muita gente falando desse livro, se não me engano até o Professor Hugo já falou, então estou indicando!!!

    Link para compra do Livro

    O que é Clean Code (código limpo)?

    Clean Code, ou código limpo, na tradução direta, é um termo que se refere a filosofia de desenvolvimento de códigos simples e objetivos. Então basicamente fazer um limpeza no seu codigo, deixando ele mais legível, e menor tirando ou diminuindo alguns partes do codigo desnecessárias.

    O foco é o ganho de produtividade, reutilização e melhoria dos códigos, afinal, um das coisas que mais atrasam o desenvolvimento de software está exatamente na manutenção das aplicações.

    Fazer a limpeza de um código não e tão fácil mas e necessário! Trocar o nome de uma variável por um melhor, converter funções grandes que fazem várias coisas para funções pequenas que fazem uma única tarefa, diminuir a complexidade do código reduzindo as regras condicionais if que ele possui, eliminar código duplicado e etc… Essas são algumas das coisas que podemos fazer para aplicar o conceito de clean code em nossos códigos.

    Porque devo usar Clean Code e por que ele é importante?

    Se tu for ver quanto melhor a qualidade de um codigo melhor e a produtividade de um programador, por que ele não vai ter que ficar lendo o codigo todo para poder entender alguma situação, o codigo se torna auto explicativo. Por isso, realizar a manutenção de um software é bem mais complicado do que desenvolver um do início

    A realidade e que os programadores passam a maior parte do tempo lendo e entendo o código do que programando, isso por que não da pra sair programando sem entender primeiro o que o codigo faz, e se o codigo e bem escrito e limpo, esse entendimento se tornar bem mais fácil, tornando o trabalho mais produtivo e rápido.

    Princípios de Clean Code?

    Vamos pontuar aqui o que um Clean Code deve ser, e suas principais características:

    • Simples e direto: Ele tem que ser simples e direto, o código bem escrito deve ter o mínimo de complexidade possível, para que possa ser facilmente depurado e compreendido.
    • Eficiente: um código é programado para atender a algum objetivo específico, então procure ver se ele funcionará conforme o seu proposito.
    • Sem Ambiguidade: Tente repetir o mínimo de código possivel na sua aplicação, se você já o inseriu em algum lugar no código-fonte, ele não deve ser implementado novamente.
    • Elegante: Bjarne Stroustrup, inventor do C++, diz que gosta dos seus códigos elegantes e que, quando você o lê, deve se sentir feliz. A ideia da elegância é tornar o código diferente dos demais.
    • Atenção aos detalhes: o programador deve sempre criar um código de forma cuidadosa, já que um código mal escrito desde o início impactará em sua manutenção, trazendo grandes prejuízos e lentidão para entendê-lo.
    • Atenção aos comentários: comente o mínimo possível em seu código. O código já deve ser claro o suficiente para não necessitar de comentários. Caso necessite, tente comentar o mínimo possível.

    Testes

    Diante dessas características a cima é sempre importante se lembrar que o código escrito por você passará, provavelmente, por manutenções e refatoração. O código só será considerado limpo mesmo se passar pelos testes.

    Ao criar um software, é preciso garantir que cada linha seja validada, e que ele mantenha-se funcionando, mesmo aplicando o Clean Code.

    Como escrever um bom código?

    • Defina bons nomes: o nome é essencial para o código ele deve ser direto e representar bem o que significa, mesmo que seja necessário usar um nome extenso, use nomes claros, para que não haja mais confusão, nomes bons dispensam o uso de comentários.
    • Nomes de Classes: evite palavras conflitantes com os componentes da linguagem e use substantivos em vez de verbos.
    • Nomes de Métodos: devem sem bem claros na intenção do desenvolvedor, como “ExcluirPagina”.
    • TDD: volto a repetir é preciso testar tudo, o tempo todo, para evitar erros, e caso haja erros e preciso garantir formas de tratá-lo, ou seja teste tudo e valide os erros!
    • Formatação: cuide da formatação e da indentação do código para melhorar sua legibilidade.
    • Pacote ou package: categorize os códigos em pastas(pacotes) para que fiquem mais organizados e elegantes.

    E isso galera, vale dar mais umas pesquisadas sobre Clen Code, inclusive deixarei alguns video abaixo para vocês verem sobre:

    Clean Code - Vídeo 1

    Clean Code - Vídeo 2

    Clean Code - Vídeo 3

    Clean Code - Vídeo 4

    Se gostou do post de um like e comente ai es já sabia sobre o Clean Code, e se você vai começar a utilizar….

    • 13 respostas
    1. Natasha Lima @natashalima
        2023-01-11 12:46:32.696Z

        Oi Hebert, eu estava pensando nesse livro agora kkkk eu tenho link do livro em um repositório, será que posso colocar aqui ?

        1. André Filipe @andresantos
            2023-01-12 01:43:41.227Z

            Obrigado, Natasha. Você é uma amiga!

            1. Natasha Lima @natashalima
                2023-01-12 18:05:12.137Z

                de nada! kkkkk

              • Em resposta anatashalima:
                Hebert Almeida Rocha @HebertRocha
                  2023-01-11 14:01:56.986Z

                  Oi Natasha, pode colocar o link ai sim, sem problemas, pra quem não consegue comprar o livro isso daí e ótimo.

                  1. Natasha Lima @natashalima
                      2023-01-11 14:04:52.177Z

                      Então vou deixar aqui como resposta, coloquei o link do drive em um repositório no GitHub, segue o link: https://github.com/NatashaLima/CleanCode/tree/main

                      1. Lucas Ferreira @lksferreira
                          2023-01-11 22:13:01.134Z

                          Nossa, se você soubesse o quanto procurei por isso, hahaha Obrigado por compartilhar

                          1. Natasha Lima @natashalima
                              2023-01-12 18:05:01.002Z

                              Eu procurei muito também mdsss, todo mundo falava desse livro que eu fui até o fim do mundo pra achar kkkk

                      2. Em resposta aHebertRocha:
                        Gabriele Martins Pereira @gabi.mp
                          2023-01-11 15:20:20.791Z

                          Muito bom seu resumo! Irá ajudar muitooo! Parabéns!

                          1. Em resposta aHebertRocha:

                            Obrigada Hebert!

                            Eu já estava querendo saber mais sobre isso, por que acho importante começar desde cedo a botar em pratica os princípios do clean code para ao longo do tempo, conforme os meus códigos forem ficando complexos, eu conseguir manter ele realmente limpo hahaha

                            1. Em resposta aHebertRocha:
                              Marco Sousa @marcosousa
                                2023-01-11 21:18:07.451Z

                                Muito bem feito, mano. Vai ajudar muito esse resumão! é uma leitura "pesada" mas não tem boa prática melhor! Recomendo ler mas não se perder nele kkkkk. Um abraço.

                                1. Em resposta aHebertRocha:
                                  Larissa Leal @LariLeal
                                    2023-01-11 21:34:08.207Z

                                    Muito bacana esse resumo, dizem que não é uma indicação para quem esta começando, mas o aspecto central acho que é algo de extrema importância. Esse livro esta sempre caro, mas já vi uma galera mandando lá no whatsapp a versão em pdf, acho que se alguém quiser é só pedir lá que mandam dnovo :)

                                    1. I
                                      Em resposta aHebertRocha:
                                      Ítalo Baracho @italobaracho
                                        2023-01-12 03:42:37.879Z

                                        Vou comprar um livro físico que estão recomendando com esse nome ai "Clean Code"

                                        1. Em resposta aHebertRocha:
                                          Bruno Coelho @BrunoCoelho
                                            2023-01-12 11:23:57.486Z

                                            Muito bom Hebert! Ótimo resumo...vai contribuir bastante.