domains / / langgenius/dify
Use descriptive names
Choose names that clearly describe the purpose, behavior, or content of variables, methods, and classes. Avoid ambiguous or generic names that require additional context to understand.
Choose names that clearly describe the purpose, behavior, or content of variables, methods, and classes. Avoid ambiguous or generic names that require additional context to understand.
Key principles:
- Include units or context in names when relevant (e.g.,
timeout_secondsinstead oftimeout) - Use descriptive verbs for methods that indicate their action (e.g.,
create_or_updateinstead ofcreate_alias) - Specify the role or relationship in parameter names (e.g.,
_creator_user_idinstead of_created_by) - Use plural forms for collections to avoid ambiguity (e.g.,
doc_idsinstead ofdoc_id) - Choose method names that accurately reflect their behavior (e.g.,
preserve_flask_contextsinstead offlask_context_manager)
Examples of improvements:
# Before: Ambiguous naming
def create_alias(user, timeout):
doc_id = set()
# After: Descriptive naming
def create_or_update_alias(creator_user_id, timeout_seconds):
doc_ids = set()
This practice makes code self-documenting and reduces the cognitive load for developers reading and maintaining the codebase.