Coding Standards

Naming Conventions

No numbers in names except for files!

Variables:

• Name: camelCase

var exampleVariable

Constants:

• Name: ALL_CAPS

const EXAMPLE_CONSTANT

Enums:

• Name: PascalCase
• Members: ALL_CAPS

enum ExampleEnum {
WALKING,
IDLE,
JUMPING
}

Functions:

• Name: snake_case
• Parameters: camelCase

func example_function_name():

Classes:

• Name: PascalCase

class BaseEnemyClass

Files/Scenes/Scripts:

• Name: PascalCase

res://LevelFolder
TutorialLevel.tscn
PlayerScript.gd

---

Commenting

Always include a single space between the start of a comment and the first word, additionally always capitalize the first letter! When writing particularly complex code that might be hard to follow, provide adequate description.

Variables:

• 1 Hashtag
• Appears above declaration
• Related variables/comments grouped together for clarity, groups separated by spacing

# My cool variables
var myVariable: int
var myOtherVariable: bool = true

# My monetary variables
var dollars: int
var cents: int

# My unrelated variable
const myUnrelatedVariable = 42

Functions:

• 2 Hashtags
• Appears above function
• Summary of the functions
• Descriptions of the fields
• Return value
• Comments in code blocks where necessary describing complex sections
• Include any references/resources used

## Adds two numbers together
## x: First number 
## y: Second number 
## Returns the sum of both numbers
## https://stackoverflow.com/questions
func add_nums(x: int, y: int) -> int:
	# Adds both numbers together
	return x + y

Tags

• 1 Hashtag
• Appears above related section
• ALL CAPS no spaces
• Use tags throughout code for actionable/notable items

# BUG: [Description of bug]
# TODO: [Description of work that still needs to be done]
# STRETCH: [Short description of stretch goal that would go here]