-
Notifications
You must be signed in to change notification settings - Fork 0
Model element naming conventions
I cannot overstate the value of strict adhererence to a naming convention, especially when it comes to managing large model sets.
This isn't just about making the models pretty or satisfying an obession for neatness.
It's really all about getting your models up and running as soon as possible and not having to spend forever chasing down minor bugs.
For example, let's say that during execution your models keep breaking for some reason. And it turns out its because of a subtle typo in a name that you just aren't seeing. If you follow naming conventions you are much more likely to see that you specified a type where an attribute name should have been since you notice the initial caps in each of the name's words.
That's just one example of many, in my experience, where I saw a problem immediately simply by noticing a name out of place.
All words in title case
Initial cap first word only
All letters in capitals
First word in initial caps (question mark at end of name allowed)
All words lower case
First word in initial caps
Each word has initial cap
Copyright 2020, 2021, 2022, 2023, 2025 © Leon Starr under MIT Open Source License
- Why they are problematic
- Instance attribute creation values
- Boolean values
- Special values
- Enumerated values
- Action block
- Statement
- Single line action
- Multiple dependent actions on a single line
- An action spread across multiple lines
- A conditional group of single line actions
- Comments
- Finding instances
- Attribute access
- Creation and deletion
- Subclass migration
- Creating a table from a class
- Creating a table with a definition
- Converting a table into a class
- Set operations on tables
- Set comparisons on tables
- Join
- Rename
- Extend
- Aggregation
- Rank
- Image
- Input values
- Signatures and name doubling
- Output values
- Execution order
- Sequential execution
- Conditional execution
- Signals
- Scrall has no for_each action
- Iteration