Choose clear, descriptive names for variables, methods, types, and parameters that unambiguously convey their purpose and avoid conflicts. Prefer full words over abbreviations and ensure names are specific enough to prevent clashes with inherited or similar functionality.
Choose clear, descriptive names for variables, methods, types, and parameters that unambiguously convey their purpose and avoid conflicts. Prefer full words over abbreviations and ensure names are specific enough to prevent clashes with inherited or similar functionality.
Examples of improvements:
options
instead of opts
for better clarityTransportType
instead of Protocol
when the term “protocol” is overloaded in the domainonMcpError
instead of onError
to avoid conflicts with base class methodsThis practice reduces cognitive load, prevents naming conflicts during inheritance or composition, and makes code more maintainable by clearly expressing intent through naming.
Enter the URL of a public GitHub repository