Styleguide for writing scenarios
Standardization projects and Software projects usually have a common StyleGuide. This eases to read the examples and gives a more consistent look. At the moment there seems no such thing in this project.
Therefore my questions:
- Shall we at least use one style for the standard examples?
- Shall we provide a very simple and only "recommended" style guide?
Here is a very minimal proposal, which is aligned with most programming language StyleGuides: Spoiler: I copied a lot of stuff from the GoogleStyleGuide...
Variable names
# The names of variables (including function parameters) and data members (fields) are all lowercase, with underscores between words.
# OK - lowercase with underscore.
vehicle_name: String = "offroad_vehicle_xyz"
aggressive_driving: bool = false
vehicle_id: int
# Bad - mixed case.
vehicleId: int = 2;
# This also applies for fields of a class:
class Vehicle:
id: int
is_offroad: bool = false
# If a class is instantiated, its variable name must be again consistent:
my_vehicle_1: Vehicle
Type names
# Type names start with a capital letter and have a capital letter for each new word, with no underscores:
struct EmergencyVehicle
enum TrafficLightColor