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.

Type

Book

Intellectual base

Review or monograph

Year

2009

Link

https://www.pearson.com/en-us/subject-catalog/p/clean-code-a-handbook-of-agile-software-craftsmanship/P200000009044

Cited from

computer_science

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 process that 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.

Domain-specific

• Code Smell
  • . 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.

• Magic number (programming)
  • In its code-smell sense, a magic number is an unexplained literal whose meaning is hidden rather than named.

Verification

This reference passed the adversarial substantiation pipeline: it was checked to exist and to support the claim it is attached to. See how references were verified.

Registry ID ref:8d6ecab88405 · see in the full table