Clean Code e a importância das boas práticas de programação · obrenoalvim

Antes de qualquer coisa, tenho que fazer uma menção honrosa a playlist do Filipe onde ele aborda justamente o que vou falar aqui, então para quem quiser dar uma olhada, segue o link:

https://www.youtube.com/watch?v=9w3o9NHXqu0&list=PLMdYygf53DP5Sc6yFYs6ZmjsuuA2fu0TK

Bom, para quem já está na área a um certo tempo, já deve ter notado que da para fazer a mesma coisa de 1 milhão de formas diferentes, por um lado parece ótimo, mas infelizmente não é tão bom assim. Ao criar uma Classe, uma função ou simplesmente declarar uma variável de "qualquer forma", o programador está dando um tiro no próprio pé. TODO sistema, por mais simples que seja, precisa de manutenção, logo, escrever um código simples, limpo e objetivo ajuda na manutenção e evita erros futuros.

Clean Code

Um bom código deve ser:

• Simples: Fácil de entender;
• Objetivo: Vai direto ao ponto;
• Eficiente: Faz o que é proposto;

Dicas

Nomes Significativos

Métodos, variáveis, funções e etc. devem possuir um nome que tem relação com o seu objetivo.

Segue o exemplo:

let n = "brenoalvim";

O nome da variável nesse caso não ajuda em nada a reconher para o que ela serve.

Seria muito mais eficaz um código feito assim:

let usernameGithub = "brenoalvim";

O nome da variável já deixa esclarecido o que ela está armazenando, sem precisar sequer ler novamente, o que economiza muito tempo.

Convenções de nomenclatura

Para seguir um padrão de projeto, é muito importante manter a consistência em tudo e isso inclui a maneira que o programador declara a variável e para isso existem as nomenclaturas:

• Camel Case

Deve começar com a primeira letra minúscula e a primeira letra de cada nova palavra subsequente maiúscula.

let exemploDeVariavel;

• Pascal Case

Também conhecido como “upper camel case” ou “capital case”, pascal case combina palavras colocando todas com a primeira letra maiúscula.

let ExemploDeVariavel;

• Snake Case

Conhecido também como “underscore case”, utilizamos underline no lugar do espaço para separar as palavras. Quando o snake case está em caixa alta, ele é chamado de “screaming snake case”.

let exemplo_de_variavel;

• Kebab Case

Kebab case utiliza o traço para combinar as palavras. Quando o kebab case está em caixa alta, ele é chamado de “screaming kebab case”.

let exemplo-de-variavel;