Appearance
Don't add comments that describe what a class/function does or which other code consumes it. Naming and reading the code is enough. Behavior lives in the feature docs, and change history in the commits.
What the code does is said once, by the code and its names.
Default is no comment. Only keep one for:
Two kinds of comment to drop on sight:
Builds one config per entity; triggered by the selection page...
No Describe-What Comments
Don't add comments that describe what a class/function does or which other code consumes it. Naming and reading the code is enough. Behavior lives in the feature docs, and change history in the commits.
Why
What the code does is said once, by the code and its names.
How To Apply
Default is no comment. Only keep one for:
Two kinds of comment to drop on sight:
Builds one config per entity; triggered by the selection page....Related