C# - 5 Dicas para escrever um Código Limpo - I

 Hoje vou voltar a apresentar 5 dicas importantes para escrever um código limpo na linguagem C#.

Escrever código até que não é difícil. Escrever código limpo e escalonável já é outra estória.

Já houve momentos em sua vida de desenvolvedor em que você olhou para o seu próprio código e não conseguia entender muita coisa do que havia sido codificado ?

Se você respondeu 'Sim', então você é uma pessoa real, mas não precisa ser sempre assim, pois evoluímos não é mesmo.

Então pense da seguinte forma : "O código que você escrever deve ser feito de tal forma que qualquer desenvolvedor que nunca viu o seu código antes deve ser capaz de entender o que foi feito o máximo que for possível."

Falar, ou escrever é fácil, mas por em prática e que vai fazer realmente a diferença. Escrever um código limpo é uma prática, um hábito que você deve incentivar e nunca abandonar.

Para ajudá-lo vou apresentar 5 dicas que vão te ajudar a escrever um código limpo.

1- Utilize uma boa ferramenta de trabalho

Usar a melhor ferramenta de trabalho para escrever o seu código é começar com o pé direito.

No caso da plataforma .NET o Visual Studio é um dos IDEs mais usados e também um dos melhores do mercado, principalmente para a linguagem C#.  O Visual Studio é um produto sólido, relativamente rápido e com diversos recursos para otimizar a produtividade do desenvolvedor.

As versões Community do Visual Studio são gratuitas e podem ser baixadas facilmente permitindo a criação de diversos tipos de projetos e com centenas de plugins e pacotes que podem ser usados para incrementar os seus projetos.

Outra ferramenta muito boa é o Visual Studio Code que também pode ser usada para o desenvolvimento de aplicações para a plataforma .NET usando a linguagem C#.

Existe também o IDE Rider da JetBrains que é uma outra opção de ferramenta de trabalho muito boa. O único detalhe é que ela não  é gratuita.

2- Utilize nomes significativos no seu código

Dar nome a variáveis é provavelmente a parte mais difícil de todo o ciclo de desenvolvimento.

Pensar em nomes significativos para suas variáveis e métodos consome muito tempo. Mas pular esse processo e dar nomes aleatórios também não é uma boa ideia, não é ?

Ao nomear classes, métodos, variáveis e interfaces utilize nomes significativos que sejam auto descritivos e pertinentes ao seu propósito.

Exemplo:  int d;   ou   int diasQueFaltamParaOApocalipse;    Qual dessas declarações facilita o entendimento do código ?

Embora não exista uma regra oficial para nomear variáveis podemos adotar alguns padrões e dentre alguns padrões já existentes vou citar dois padrões muito usados.

  1. Pascal Casing
    Uma palavra com a primeira letra maiúscula, e a primeira letra de cada palavra-parte subseqüente capitalizada.
    Ex - CalculaImpostoDeRenda(), ValorDoDesconto

  1. Camel Casing
    Uma palavra com a primeira letra minúscula e a primeira letra de cada palavra subseqüente-parte capitalizada.
    Ex: valorDoDesconto , nomeCompleto, valorDoImpostoSobreServico

Podemos aplicar esses padrões da seguinte forma:

1 - Ao nomear uma classe e seus métodos utilize o padrão Pascal Case
2 - Ao nomear variáveis e parâmetros utilize padrão Camel Case
3 - Ao utilizar Interfaces sempre use como prefixo inicial a letra "I" e depois siga o padrão Pascal Case

Referências: Macoratti dicas para um código limpo

3- Preste atenção à formatação do seu código

A apresentação visual do código facilita a sua leitura e o seu entendimento.

As regras de formatação afetam como o recuo, os espaços e as novas linhas são alinhados em torno das construções da linguagem de programação .NET. As regras se enquadram nas seguintes categorias:

Regras de formatação C#: regras que são específicas apenas para a linguagem C #. Os nomes das opções EditorConfig para essas regras começam com o prefixo csharp_.

Para consultar as regras de formatação acesse : C# formatting rules

Uma forma simples e rápida de formatar o seu código no Visual Studio e teclar CTRL+K e a seguir CTRL+D conforme mostrado na figura abaixo:

Simples e eficiente.

Aqui podemos incluir também a remoção de namepaces não utilizados clicando no ícone da vasoura.

Referências: NET - Sugestões e dicas para escrever um 'bom código'

4- Adicione comentários ao seu código quando pertinente mas não abuse

Se você seguir a primeira dica o seu código estará mais legível e neste caso incluir comentários deverá ser algo que você deve fazer somente se for realmente necessário.

Assim nada de incluir comentários do tipo 'Esta variável serve para ....' ou 'Este método é usado para...'.

No entanto, adicionar algumas linhas de comentários para descrever o método e seus parâmetros quando o método for muito complexo, ajuda você e os outros desenvolvedores no longo prazo, e o Visual Studio torna isso muito mais fácil para você.

Simplesmente vá acima do método em questão e digite ///; o VS vai gerar automaticamente um modelo de comentário para você, incluindo os argumentos do método.

E com isso sempre que você chamar esse método (de qualquer lugar), o Visual Studio mostra seu comentário também.

5- Escreva código que possa ser reutilizado sempre que possível

Escrever código que pode ser reutilizável é de vital importância.

Essa prática permite diminuir as linhas de código em seu projeto e torná-lo altamente eficiente.

Assim ao invés de usar o recurso Copiar/Colar , e sair copiando e colando uma função em vários locais do seu código o que você poderia fazer é criar um Projeto de Biblioteca Compartilhada e referenciá-lo em cada um dos projetos necessários.

Dessa forma, construímos funções reutilizáveis. E, se houver alguma modificação necessária, você apenas terá que alterar o código na biblioteca compartilhada, não em todos os lugares.

Utilizar uma arquitetura em camadas, mesmo que simples, dependendo do projeto, pode tornar o seu projeto muito mais robusto e fácil de manter e estender.

Aprender a dividir um problema em partes criando camadas de abstração limpas e distintas é um longo caminho para alcançar a qualidade de ter um código limpo. A reutilização de código vai de encontro ao princípio DRY e ao princípio SRP.

Veja o meu artigo : ASP .NET Core - Implementando Clean Architecture - I

Em outro artigo vamos continuar com mais dicas para escrever um código limpo.

"E muitos dos que dormem no pó da terra ressuscitarão, uns para vida eterna, e outros para vergonha e desprezo eterno."
Daniel 12:2

 

Referências:

José Carlos Macoratti