Logo

dev-resources.site

for different kinds of informations.

Boas Práticas nomeando variáveis e funções em GDScript

Published at
5/20/2024
Categories
godot
gdscript
godotengine
gamedev
Author
lliuti
Author
6 person written this
lliuti
open
Boas Práticas nomeando variáveis e funções em GDScript

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.

godotengine Article's
30 articles in total
Favicon
Game Dev Diary #1: Starting from zero
Favicon
Online Visual Novel in Godot: Case Study on Sentou Gakuen
Favicon
How to Press and Drag to Reposition a Window in Godot
Favicon
"Surf the Rails in Subway Surfers Online"
Favicon
AR Game ~ Geospatial API Sample ~
Favicon
Navigating the Skies: A Comprehensive Analysis of the Aircraft Engine MRO Market
Favicon
Going from Godot 3 to 4 (The Easy Way)
Favicon
Godot 2D & 3D Prototype Templates
Favicon
Perfecting Game Levels: The Essential Role of Playtesting
Favicon
Reading data from Mysql server
Favicon
Game Development Diary #11 : Second Day Back
Favicon
Game Development Diary #8 : Still Second Course
Favicon
Game Development Diary #7 : Second Course
Favicon
Game Development Diary #5 : Start My "BUMI" Project - Part 1
Favicon
Game Development Diary #4 : First Course Complete
Favicon
10 Useful Tips for Getting the Most Out of Godot
Favicon
Why Godot is a Game Changer in Game Development
Favicon
Game Development Diary #2 : GameDev.tv Course
Favicon
Estruturas de repetição em GDScript
Favicon
Estruturas condicionais em GDScript
Favicon
Boas Práticas nomeando variáveis e funções em GDScript
Favicon
Kingdom Hearts RE:Back Cover
Favicon
Godot Engine
Favicon
Hash SHA1 at go
Favicon
Let’s Learn Godot 3D by making an Endless Runner Game - Part 1: Project Overview & Setup 👟
Favicon
Let’s Learn Godot 3D by making an Endless Runner Game — Part 2: Environment Setup👟
Favicon
Let’s Learn Godot 3D by making an Endless Runner Game — Part 3: Player Setup & Animations👟
Favicon
Every beginning is hard or my first steps with GODOT - The 1st month
Favicon
BlackJack - Beta version
Favicon
Disney Gargoyles native porting Development Update 🚀

Featured ones: