Como escrever um codigo profissional?

Ola leitores do TabNews!! Sejam muito bem vindos, nesse artigo irei te mostrar alguns erros de codificação que você deve evitar para se tornar um desenvolvedor cada vez mais completo, vamos lá!.

Para escrever um código mais eficiente você deve evitar alguns erros muito comuns que tornam seu código menos eficiente e mais difícil de se ler, tanto para você depois de um tempo quanto para outros desenvolvedores que possivelmente vão trabalhar a partir do seu código. Essas práticas vão te ajudar a contribuir em projetos open source ou até mesmo em code review em entrevistas de emprego.

Então vamos ver esses erros um a um.

1) Variaveis com nome autoexplicativas

Se você quer escrever um código bom, limpo e fácil de se ler, você precisa usar variáveis com nomes fáceis e bem aplicados ao contexto que estão sendo usadas, variáveis bem nomeadas pode salvar bastante do seu tempo em posteriores leituras do código ou até mesmo pode te ajudar a ser visto como um bom desenvolvedor em entrevistas de emprego.

//Jeito incorreto:

let a = 17
let b = 18
function func1(){
  console.log(‘The sum is’, a + b);
}

//Jeito correto:

let num1 = 17
let num2 = 18
function addNumber(){
  console.log(‘The sume is’, num1 + num2);
}

2) Cases de escrita na programação

Existem diferentes Cases (formas) de escrever código, como por exemplo Camel Case,Pascal Case, Snake Case, Capitalize Snake Case, etc.
Se você quer que seu código seja limpo e tenha um aspecto mais bonito, então use apenas um case para maioria das variáveis/funções.

// Camel case
function addNumber(){
}
// Snake Case
function add_number(){
}
// Pascal case
function AddNumber(){
}

3) Chaves {}

Se você está escrevendo, for, while ou outro tipo de loop, funções, classes, etc. Por favor use chaves para tornar seu código mais fácil de ler e também passar um aspecto mais bonito.

// Function
function addNumber() {
}
// Loops
for(i=0; i>=5; i++) {
  console.log(i);
}

4) Indentação adequada

Indentação é o recuo que você pode aplicar no seu código. Use um padrão de recuo caso queira um código mais limpo e conciso.

// Function
function addNumber(a, b) {
  return a + b
}

// If-else
let num1 = 13
let num2 = 19
if(num1 > num2) {
  console.log(“Num1 is greater!”)
}
else{
  console.log(‘Num2 is greater!’);
}

5) Escreva bons comentários

Escrever bons comentários pode te ajudar a entender e se encontrar melhor no seu código no futuro, à medida que a aplicação cresce, é muito fácil de se perder em tantas linhas de código, os comentários servem para auxiliar neste problema. Use os comentários de forma consciente, se você precisa comentar o código para lembrar o que ele faz, eh sinal que esse código precisa de refatoração.

// Add the useful comments
// Function to add two numbers
function addNumber(a, b) {
  return a + b
}

6) Formate seu documento

Formatar o documento é um bom hábito para você. Essa prática pode tornar seu código mais bonito e fácil de se ler. Se você está usando VS Code IDE, Prettier é a melhor extensão de formatação de documento para você!

Muito obrigado por ler até aqui, se gostou do artigo compartilhe ele com as pessoas que você acha que vão agregar valor às dicas dadas aqui neste artigo. Muito obrigado novamente e sucesso!

4le Perei2a