Convenções de nomenclatura JavaScript: fazer e não fazer

Acho espantoso o número de significados diferentes que podemos obter a partir de menos de 30 caracteres. Estou a falar do alfabeto com alguma pontuação bem colocada, claro. Desde uma história de amor a um programa de computador, a escrita permitiu-nos criar mundos extraordinariamente diferentes. E a linguagem, em geral, proporciona uma estrutura na qual podemos pendurar um fluxo de ideias.

As linguagens de programação parecem ter padrões muito rigorosos – certos termos têm de ser utilizados em certos lugares. Mas uma área onde existe uma enorme quantidade de liberdade é a forma como nomeamos esses termos.

Toma este programa simples que cria uma frase a partir de um conjunto de palavras, adiciona um sinal de pontuação, e regista-o na consola:

Nada muito especial, certo? Mas o que pode não ter considerado é quantos termos foi responsável por nomear.

Existem 23 palavras (não incluindo valores codificados) no programa acima. Nós controlamos os nomes de 14 dessas palavras. Isto é mais de 60% do que foi datilografado, era nossa responsabilidade nomear!

Você é responsável pela maioria dos nomes no seu programa

Se estiver a construir uma aplicação empresarial ou um simples Olá, World, quer que o seu programa leia como um Times Bestseller, e não como um livro de trabalho Mad Libs.

Não se trata de um manifesto sobre como estruturar uma aplicação JavaScript inteira, mas sim de um capítulo sobre como escolher nomes para as coisas em que tem a liberdade de o fazer. Incluí as várias referências na parte inferior, se quiser saber mais. Uma última coisa, a chave de todas as nossas convenções e normas é esta:

A maior parte destas convenções não são para si hoje, mas sim, para si e para as pessoas que lêem o seu código amanhã.

Referências e aprendizagem contínua

  1. “Código Limpo” de Robert C. Martin – Uma grande leitura para todas as línguas. Vai além das convenções de nomeação e propõe toda a estrutura do seu programa. Os exemplos estão em Java, mas os princípios aplicam-se ao JavaScript.
  2. “Clean Code JavaScript” de Ryan Mcdermott – O livro acima, mas refeito para JavaScript. Está disponível online e é gratuito.
  3. “Airbnb JavaScript Style Guide” – Possivelmente o guia de estilo mais abrangente para JavaScript. Contém não só o quê, mas também o porquê. (Se estiver num pequeno dispositivo, poderá ter de clicar em “ver tudo readme” para ver o documento completo).
  4. W3 JavaScript Style Guide – Um guia de estilo curto e conciso.
  5. Guia de Estilo ES6 do Google – Guia de estilo do Google para JavaScript.

Obrigado pela leitura!

woz

P>Siga-me no Twitter.

Deixe uma resposta

O seu endereço de email não será publicado. Campos obrigatórios marcados com *