Nomeando variáveis e funções - GDScript
Na hora de nomear variáveis e funções em GDScript, adotar boas práticas não só torna o código mais legível, mas também facilita a manutenção e colaboração com outros desenvolvedores. A escolha de nomes claros e descritivos pode fazer toda a diferença na compreensão do propósito de cada elemento do código.
Deixarei aqui algumas dicas que costumo seguir ao escrever meus códigos:
Clareza e (principalmente) Descritividade:
Os nomes devem ser claros e descritivos, refletindo o propósito e o contexto da variável ou função.
Sem abreviações obscuras, como "pHealth" ou siglas pouco intuitivas, como "x" ou "y".
Opte por nomes completos que transmitam claramente a intenção, como: "player_health".
Convenções de Nomenclatura:
Use o padrão snake_case para nomes de variáveis e funções, onde as palavras são separadas por underline (como no exemplo de "player_health").
Consistência:
Mantenha todo o código consistente. Isso torna mais fácil para os desenvolvedores entenderem o projeto.
Seja consistente com a escolha de nomes para tipos semelhantes de variáveis ou funções.
Por exemplo, a variável de vida do inimigo não deve ser chamada de "enemy_life_points" enquanto a do jogador é "player_health".
Bom, idealmente nem precisaríamos do prefixo "player" ou "enemy"...
Evite Nomes Genéricos:
Nomes genéricos como "temp", "data", "index" etc.
Não comente:
Sim. É isso mesmo. Mas não me refiro a todo tipo de comentário.
É claro que há bons comentários e péssimos comentários. Geralmente, não precisamos de uma explicação do que a função _physics_process faz.
Um bom comentário explica efeitos colaterais de uma função. O nome da função já deve ser suficiente para explicar sua responsabilidade.
Top comments (1)
Um outro detalhe é o famoso camelCase que já dá também uma separação das coisas (clareza, como você citou), ex enemyLifePoints, playerHealth, eu gosto muito e uso no dia a dia, mas no final do dia ambas abordagens são eficientes :).