Clean Code - A handbook of agile software craftsmanship¶
Martin, R. C. (2009). Clean Code - A handbook of agile software craftsmanship: A Handbook of Agile Software Craftsmanship. Prentice Hall.
Cited by¶
4 citations across 4 artifacts.
Each citation links to the sentence it supports in the citing article.
Primes¶
- Explanatory Overlay Masking Structural Debt
- Consider a function named
processthat takes a flag argument and is preceded by a twelve-line comment block explaining "if flag is true this validates and persists; if false it only validates; do not call with false during a transaction; the second return value is the error count."This sourceTreats explanatory comments and overloaded, vaguely-named, multi-responsibility functions as smells to be retired by renaming, decomposing into single-responsibility functions, and promoting return values into typed results.
- Consider a function named
Domain-specific¶
- Code Smell
- . Function and API design — long parameter lists, flag arguments, and hidden temporal coupling
SupportedVerified against the source
- . Function and API design — long parameter lists, flag arguments, and hidden temporal coupling
- Curse Of Knowledge
- Writing and exposition — authors who deeply know their material write past their audience, and the editor's role is in large part a curse-of-knowledge corrective; plain-language movements are institutional responses. Software engineering — code the author finds self-evident is opaque to maintainers, which is why documentation, code review, and rubber-duck explanation exist.
This sourceArgues that code clear to its author is opaque to other maintainers who lack the author's context, motivating readability discipline, documentation, and code review.
- Writing and exposition — authors who deeply know their material write past their audience, and the editor's role is in large part a curse-of-knowledge corrective; plain-language movements are institutional responses. Software engineering — code the author finds self-evident is opaque to maintainers, which is why documentation, code review, and rubber-duck explanation exist.
- Magic number (programming)
Verification¶
Does it exist? Not checked yet. This entry carries no identifier to resolve. It was extracted from the citation as written in the article, normalized, and deduplicated against the rest of the registry.
Does it back the claim? Read against the text for 1 of 4 citations: 1 supported. Each verdict is shown under its citation below, with what in the work backs the sentence.
Support is checked per citation rather than per work — the same source can be cited soundly in one article and wrongly in another. Per-citation recording began recently, so a citation with no recorded check is a gap in the record rather than evidence it went unchecked.
See how references were verified.
Registry ID ref:8d6ecab88405 · see in the full table