Quais São Algumas Práticas Comuns para Nomear Variáveis e Funções?

Nomear variáveis e funções é um aspecto importante para escrever código limpo, legível e sustentável. Boas práticas de nomenclatura tornam seu código autoexplicativo reduzindo a necessidade de comentários extensos e facilitando para outros desenvolvedores incluindo você no futuro entender seu código. Vamos começar com as convenções gerais de nomenclatura em JavaScript. In previous lessons you learned about using camel case for variable names. Para variáveis booleanas, é uma prática comum usar prefixos como is, has ou can. Isso informa imediatamente ao leitor que a variável é um booleano:
let isLoading = true;
let hasPermission = false;
let canEdit = true;
Para funções, o nome deve indicar claramente o que a função faz. Frequentemente é útil começar com um verbo:
function getUserData(){
  /* ... */
}

function calculateTotal(){
  /* ... */
}

function validateInput(){
  /* ... */
}
Para funções que retornam um booleano frequentemente chamadas de predicados, você pode usar os mesmos prefixos is, has ou can:
function isValidEmail(email) {
  /* ... */
}

function hasRequiredFields(form) {
  /* ... */
}
Quando você tem funções que recuperam dados é comum começar com a palavra get:
function getProductDetails(productId) {
  /* ... */
}

function getUserProfile(userId) {
  /* ... */
}
Quando você tem funções que definem dados é comum começar com a palavra set:
function setUserPreferences(preferences) {
  /* ... */
}

function setPageTitle(title) {
  /* ... */
}
Para funções manipuladoras de eventos, você pode prefixar com handle ou sufixar com handler:
function handleClick(){
  /* ... */
}

function onSubmit(){
  /* ... */
}

function keyPressHandler(){
  /* ... */
}
Um manipulador de eventos é uma ação que acontece depois que um evento ocorreu, como um clique de botão. Você aprenderá sobre isso em lições futuras. Ao nomear variáveis de iterador e loops, é comum usar letras únicas como i, j ou k, mas para loops aninhados ou iterações mais complexas nomes mais descritivos podem ser úteis:
for (let i = 0; i < array.length; i++) {
  /* ... */
}

for (let studentIndex = 0; studentIndex < students.length; studentIndex++) {
  /* ... */
}
Para nomes de arrays, considere usar substantivos no plural para indicar que a variável contém múltiplos itens:
const colors = ['red', 'green', 'blue'];
const userNames = ['Alice', 'Bob', 'Charlie'];
Lembre-se que o objetivo é tornar seu código o mais autoexplicativo possível. Uma boa regra prática é que se você precisar adicionar um comentário para explicar o que uma variável ou função faz, talvez queira considerar renomeá-la para algo mais descritivo. Por fim, seja consistente com sua base de código ou equipe. Se sua equipe estabeleceu convenções de nomenclatura, siga-as. A consistência torna o código mais legível e fácil de manter para todos os envolvidos.
Este módulo não possui perguntas. Marque como concluído.