Choose names that clearly communicate the purpose, functionality, and usage context of variables, methods, and types. Avoid ambiguous or overly generic names that require additional context to understand.
Choose names that clearly communicate the purpose, functionality, and usage context of variables, methods, and types. Avoid ambiguous or overly generic names that require additional context to understand.
When naming:
readWithCancelHandle
instead of a generic property)Example from codebase:
// Instead of unclear property access:
if (this[kStreamBaseField]![_readCancel]) {
// Use descriptive method name:
if (this[kStreamBaseField]!.readWithCancelHandle()) {
Good naming reduces the need for comments and makes code self-documenting, improving maintainability and reducing cognitive load for other developers.
Enter the URL of a public GitHub repository