DEV Community

Cover image for Como escrever códigos mais padronizados?
Matheus dos Reis de Jesus
Matheus dos Reis de Jesus

Posted on

Como escrever códigos mais padronizados?

Capa por Tim Graf no Unsplash

Sumário

Introdução

Quem me acompanha nas redes sociais sabe que, recentemente(junho de 2019), eu mudei o rumo da minha carreira. Estava trabalhando com Data Science e decidi focar no desenvolvimento mobile iOS. A partir disso, tive que me dedicar a aprender Swift, linguagem lançada pela Apple em 2014.

Para aprender novas linguagens, é necessário conhecer padrões: sintaxe, comandos, paradigmas e por aí vai. Um detalhe muito importante é: Qual o padrão para se escrever códigos na linguagem que estou aprendendo? Para isso existem os style guides.

O que é Style Guide?

Em português, Guia de Estilo, é um conjunto de regras que definem como devem ser escritas as mais variadas instruções em uma determinada linguagem. Essas regras envolvem preferências sobre, por exemplo, iniciar ou não uma nova linha antes de das chaves de um comando if. Um exemplo de regra a seguir:

// Preferido
if(condition) {
   //code
}
// Não preferido (lógico, um crime)
if(condition)
{
   //code
}
Enter fullscreen mode Exit fullscreen mode

Os style guides são criados para (tentar) garantir que o código terá um mesmo formato, independentemente de quem escreveu, tornando mais fácil sua leitura por qualquer pessoa.

Quem define um guia de estilo?

Os guias de estilo podem ser definidos por um projeto, empresa, comunidade, etc. Por exemplo, dentro de uma empresa, é possível que diferentes projetos sigam diferentes guias, cada um adequado às suas necessidades.

No que isso vai me ajudar?

Conhecer um guia de estilo pode tirar muitas dúvidas sobre como um "bom código" deve ser escrito. Você irá conhecer e entender como formatar determinados comandos, como escrever expressões, onde colocar ou não espaços, etc.

Exemplos

Abaixo estão listados alguns exemplos de guias de estilo para você conhecer:

Top comments (5)

Collapse
 
santanaluc94 profile image
Lucas Teixeira dos Santos Santana • Edited

Boa matéria mano. Achei que só ficou faltando colocar pra js e dart.

Collapse
 
reisdev profile image
Matheus dos Reis de Jesus

Obrigado! Que não seja por isso, acrescentei pra essas linguagens também.

Collapse
 
santanaluc94 profile image
Lucas Teixeira dos Santos Santana

O maluco é brabo mesmo!

Collapse
 
lelepg profile image
Letícia Pegoraro Garcez

Uma outra dica muito interessante relacionada a este assunto é a utilização de formatadores de código. Eu costumo utilizar a extensão prettier no Visual Studio Code pra fazer a formatação do código javascript.
Com ela eu só preciso definir as regras de formatação em um arquivo e então utilizar o prettier como formatador padrão de código. Como as regras de formatação são definidas dentro de um arquivo no projeto, é possível utilizar regras diferentes de acordo com o projeto que você está trabalhando.
Sinto que utilizar esta extensão e deixar meus códigos formatados tem ajudado muito na legibilidade deles, e realmente indico que as pessoas sigam um determinado estilo de formatação, mesmo que seja automatizado como é o meu caso.

Collapse
 
eduardoklosowski profile image
Eduardo Klosowski

Uma das primeiras coisas que busco quando estou aprendendo uma linguagem nova é um lint justamente para me forçar a seguir o style guide, no começo tem alguma briga, mas depois acostuma.