Convenções de codificação

Arthur
nibotech
Published in
3 min readSep 18, 2019

Vamos continuar a série de conteúdos relacionados a como colocar em prática alguns conceitos que nós ,desenvolvedores, na maioria das vezes já conhecemos…

E o assunto de hoje é: convenções de codificação. Para exemplificar o assunto, escolhi as convenções do C#.

Primeiro ponto, para que serve essas convenções afinal de contas? Na nossa visão aqui do Nibo, buscamos escrever um código de uma forma muito clara, isso para que outros desenvolvedores do time entendam o que está acontecendo em cada trecho de código e saibam quando utilizar cada recurso disponibilizado nesse código.

Código disponível no github
No exemplo acima, mostro o que estou dizendo

Ok! Entendemos o que isso quer dizer. Agora partindo para os detalhes da convenção (link da documentação), está dividida em 4 partes importantes:

  • Convenções de nomenclatura
  • Convenções de layout
  • Convenções de comentários
  • Diretrizes da linguagem

Vou citar 3 pontos que considero mais importante sobre isso.

O primeiro é o uso do var. Estamos acostumados a colocar var em praticamente tudo, e algumas vezes pode causar confusão. E na convenção a recomendação é simples: não usar quando não estiver explícito do lado da atribuição. Vejamos:

ConvencoesDiretrizesExemplo1 no github

A próxima parte importante é sobre não se basear no nome da variável para especificar o tipo dela. Ou seja, ao invés de explicitar o tipo, usamos o var e para piorar colocamos no nome da variável o tipo. Tem grandes chances de você já ter cometido essa gafe, mas fica tranquilo, você não está sozinho!

Com isso abordamos 2 pontos, então vamos pro próximo:

operadores “& e &&” e “| e ||”. Resumidamente, utilizar isso da forma correta faz com que a sua aplicação seja mais rápida por não ter que executar sempre todas as possibilidades. Ou seja, quando você utiliza “&” ou “|”, obriga sua aplicação a checar todas as possibilidades de um “if” por exemplo. E utilizando “&&” e “||” sua aplicação só executa as operações até ela ter o suficiente para considerar um resultado verdadeiro ou falso. Dá uma olhada:

Essas são as recomendações da própria Microsoft relacionados a como codificar. Independente da linguagem que você trabalha, provavelmente existe essas convenções que você pode seguir. Espero que tenha ajudado de alguma forma a você a entender esses assuntos. Comentem e deem feedbacks sobre os posts.

Link da documentação: https://docs.microsoft.com/pt-br/dotnet/csharp/programming-guide/inside-a-program/coding-conventions

Link github Nibo: https://github.com/nibodev

--

--