Table of Contents
1. Naming Conventions
Follow these guidelines to create clear, self-documenting variable names:| Convention | Description | Example |
|---|---|---|
| Lowercase | All variable names in lowercase to avoid conflicts | username="alice" |
| Snake case | Use underscores for multi-word names | first_name_last_name="Alice" |
| Descriptive names | Reflect the variable’s purpose | config_file="/etc/app.conf" |
| Single-letter (optional) | Only for simple counters or arithmetic operations | x=10 |
Avoid uppercase names for regular variables—uppercase is conventionally reserved for constants (see Defining Constants).
2. Defining Constants
When you have values that should never change, define them in uppercase snake_case and mark them as read-only:readonly serves two purposes:
- Clarity: Signals to readers that these values are fixed.
- Safety: Prevents accidental reassignment later in the script.
Attempting to modify a
readonly variable will produce an error: