Deploy na Sexta #16: Como escrever bons códigos desde o início?
Aprendendo a programar com padrões 🖖
Minha primeira funcionalidade desenvolvida sozinha no meu primeiro estágio, estava orgulhosa. Enviei minha PR para code review ansiosa para ver meu desenvolvimento rodando no cliente. Um colega que me apoiava no time me chamou de cantinho no escritório:
_Bá Gi, parabéns pelo desenvolvimento, mas isso aqui tá um show de horror! 😂
Quando começamos nossa jornada profissional na programação, é natural que os primeiros códigos que escrevemos não atinjam um alto padrão de qualidade de código. Isso é completamente normal e esperado, especialmente para estagiários. Empregadores entendem que estamos em fase de aprendizado. Mesmo assim, os feedbacks iniciais sobre nosso trabalho, embora possam parecer desanimadores, representam uma etapa crucial no nosso desenvolvimento profissional.
Ah, sobre o Code review. Ele é um processo essencial no desenvolvimento de software, onde o código que produzimos é avaliado por um ou mais colegas antes de ser incorporado ao código principal do projeto. Esse processo assegura que o código satisfaça determinados padrões de qualidade e siga as convenções de codificação estabelecidas pelo projeto.
Para iniciantes, a qualidade esperada leva em conta o estágio inicial de aprendizado. Espera-se que o código seja claro e compreensível, o que inclui o uso de nomes significativos para variáveis, funções e classes, além da simplicidade, evitando complexidades desnecessárias. Por exemplo, logo que li sobre usar operadores ternários e expressões lambda do C# para compactar o código em uma única linha, aplicava em todos os lugares, mas o ideal é optar por soluções simples que sejam facilmente compreensíveis e mantenham o código acessível tanto para iniciantes quanto para desenvolvedores experientes.
Ontem fiz um post sobre convenções de codificação. Elas são um ótimo ponto de partida para quem deseja escrever bons códigos. Essas convenções, definidas pela comunidade da linguagem, orientam a escrita e organização do código, desde a nomenclatura de variáveis até a formatação, como a indentação, uso de espaços e a documentação. Um prato cheio para iniciantes perdidos. Elas garantem que o código seja consistente, legível e mantenível, facilitando a colaboração entre desenvolvedores de diferentes partes do mundo.
As convenções de codificação servem para melhorar a legibilidade, facilitando a compreensão rápida do código, e aumentar a manutenibilidade, permitindo que problemas sejam identificados e corrigidos com mais eficiência. Elas também promovem a colaboração, reduzindo o risco de conflitos no código e suavizando a integração de trabalhos de diferentes pessoas, além de elevar a qualidade do código ao minimizar chances de erro.
Como encontrar e usar convenções de codificação? 🤔
Tu podes começar com a busca pelos padrões reconhecidos pela comunidade da linguagem que tu está utilizando. Esses guias geralmente podem ser encontrados na documentação técnica oficial da linguagem. Com C# que é minha stack, encontrei esse material na documentação oficial da Microsoft. Além disso, comunidades online, fóruns e projetos de código aberto em C# são ótimas fontes para descobrir convenções adotadas pela comunidade.
Ah, mas vale lembrar que essas convenções não são normas. Tu podes escolher um guia que se alinhe com as necessidades do seu projeto ou a cultura da tua equipe. Nas empresas, muitas vezes existem padrões pré-definidos que devemos seguir. mas vale discutir com a equipe e chegar a um consenso sobre qual conjunto de regras seguir.
Outra dica é o uso de ferramentas como linters e formatadores de código. O Visual Studio, por exemplo, oferece recursos integrados que podem ajudar a garantir que nosso código C# esteja em conformidade com as convenções escolhidas. Ferramentas como o ReSharper ou o StyleCop podem analisar seu código em busca de inconsistências e até mesmo sugerir correções automáticas para muitos problemas comuns de estilo e formatação.
É importante lembrar que as convenções de codificação e as ferramentas são meios para manter a qualidade e a consistência do código, mas devem ser usadas com flexibilidade.
Me conta nos comentários: Tu já conhece as convenções de codificação da tua linguagem de programação? Tu usa elas no dia a dia? Conta tua experiencia pra gente, e é claro, quero saber se tu já mexeu naquele código tão mal escritos que era quase irreconhecível a tecnologia que estava sendo utilizada? É raro, mas acontece com frequencia 😂
🧠 Exercício da Semana
Vimos a importância das convenções de codificação e como elas podem melhorar significativamente a qualidade, legibilidade e manutenção do código, quero propor um exercício prático de forma que tu aproveite e aplique esses conceitos em um contexto real.
Pesquisa: Comece pesquisando as convenções de codificação recomendadas para tua linguagem. Podes iniciar tua busca na documentação oficial da tua linguagem.
Escolha um Guia de Estilo: Com base em sua pesquisa, selecione um guia de estilo de tu achou ser a mais utilizada. Pode ser o guia oficial, o da tua empresa, ou qualquer outro que tu encontres durante sua pesquisa e que seja aceito pela comunidade.
Análise Crítica: Analise o guia de estilo escolhido. Preste atenção às regras sobre nomenclatura de variáveis, formatação de código, uso de comentários e documentação. Reflita sobre como cada uma dessas regras pode contribuir para tornar o código que tu escreves hoje mais limpo, legível e fácil de manter.
Aplicação Prática: Escolha um trecho de código que tu já escreveu ou encontre um exemplo online. Refatore esse código aplicando as convenções de codificação que tu estudou. Concentre-se em aplicar as regras de nomenclatura, formatação e documentação.
Reflexão e Compartilhamento: Após refatorar o código, reflita sobre o processo. O código ficou mais fácil de entender? Tu encontrou alguma dificuldade em aplicar as convenções? Compartilhe suas descobertas, numa rede social junto com o código antes e depois da refatoração. Discutir suas experiências pode trazer mais feedbacks, e melhorar tua compreensão sobre as convenções.
Lembre-se, usar um conjunto de regras de codificação não é apenas sobre tornar o código mais organizado; é sobre facilitar a colaboração, melhorar a qualidade do software e acelerar o processo de desenvolvimento. 🖖
💡 Indicações da semana
E se nos apaixonassem por um sistema operacional? Não to falando do windows com certeza 😂. Me refiro ao filme Her. Nesse filme um escritor solitário, que acaba de comprar um novo sistema operacional para seu computador, acaba se apaixonando pela voz da IA, dando início a uma relação amorosa entre ambos com muitas reflexões sobre nossas relações afetivas, dilemas éticos e morais.
Falando nisso, tenho pet robô. A Loona pet bot é uma IA que simula comportamentos de um cachorrinho. Tem personalidade, capacidade de aprendizado, integração com ChatGPT. Em breve trarei review sobre a experiencia, mas estou surpresa com movimentos e interação com linguagem natural da bichinha. Ela veio lá da loja BRMetaVerso. Usa meu cupom SPACECODING caso compre algo por lá.
Como contribuir para projetos Open Source, além do código? Neste tutorial, Glaucia Lemos aborda, de um jeito super envolvente, prático e direto ao ponto, estratégias para participar ativamente de projetos de código aberto.
Em busca da trilha sonora enquanto programa? Essa é pra quem curte RAP. To montando uma curadoria de mulheres do rap nacional, mas ainda tem pouquinhas músicas, se tiver mais dicas, fica a vontade para deixar nos comentários, vou amar conhecer.
Essa foi uma semana difícil para mim com projetos, muitos bugs, tive um feedback negativo sobre meu desempenho e tenho encontrado dificuldade para produzir como gostaria no projeto que estou atuando. Mesmo bastante cansada, lembrei que eu te tenho por aqui e não poderia deixar de escrever a nossa newsletter semanal. Obrigada por me acompanhar. Se tu leu até aqui, saiba que a carreira é sobre altos e baixos e que uma comunidade que fortalece nos ajuda nos momentos de dificuldades 💙
Nos encontramos no próximo deploy, sexta às 6:00.
Faltou Tasha & Tracei na coletânea de RAP feminino