Naming Conventions
Meaningfull Process Configurations
Use Action-Oriented Names
States often represent an action or a condition of an entity. Use descriptive, action-oriented names to make their purpose clear.
Examples:
SendMessagefor sending a message.HandleErrorfor error handling.ValidateInputfor input validation.
Keep Names Concise but Descriptive
Avoid overly long or ambiguous names. A concise yet descriptive name improves readability.
- ✅
ProcessingOrder - ❌
CurrentlyProcessingTheCustomerOrder
Use Consistent Verb Tenses
Stick to a single tense across all state names, typically present participle (e.g., Processing) or infinitive (e.g., Process).
- ✅ Use
SendingEmail,ProcessingData. - ❌ Avoid mixing tenses like
SendEmail,ProcessingData.
Choose a Consistent Naming Style
Choose a consistent style depending on your coding environment or organizational guidelines.
- PascalCase:
SendMessage,HandleError. - snake_case:
send_message,handle_error. - SCREAMING_SNAKE_CASE (for constants):
SEND_MESSAGE,HANDLE_ERROR.
Avoid Redundant or Implicit Context
Do not include redundant information that is already implied by the FSM context or structure.
- ✅
Validating - ❌
OrderProcessing_Validating(if it’s already under OrderProcessing).
Consider State Purpose
Choose naming conventions based on whether the state represents:
- Actions:
LoadingData,ConnectingToServer. - Conditions:
ErrorOccurred,WaitingForInput.
Use Domain-Specific Language
Match names with terms used in the domain or industry the FSM represents. This ensures familiarity for users and developers.
- In networking:
Connecting,Listening,Established. - In e-commerce:
CartEmpty,PaymentProcessing,OrderCompleted.
Example: Order Management
Top-Level States:
NewOrderProcessingOrderOrderCompletedOrderCancelled
Nested States Under ProcessingOrder:
ValidatingOrderPackingOrderShippingOrder