Choose specific, purpose-revealing names that clearly communicate intent rather than generic, abbreviated, or ambiguous terms. Names should describe what something does or represents, not what it doesn't do.
Choose specific, purpose-revealing names that clearly communicate intent rather than generic, abbreviated, or ambiguous terms. Names should describe what something does or represents, not what it doesn’t do.
Examples of improvements:
script_engine
instead of generic engine
to clarify the file’s purposeworkspace_diagnostics
instead of abbreviated w_diagnostics
for clarityshush
instead of noop
when the function has side effects (not truly a no-op)variables::expand()
instead of expand_args()
to be clearer about what it operates onApply this by:
engine
, handler
, manager
without qualifying contextThis principle improves code readability and reduces the cognitive load for developers trying to understand unfamiliar code.
Enter the URL of a public GitHub repository