Chapter 4. THE WRITESTUFF

Techniques for Writing “Self-Documenting” Code

Real seriousness in regard to writing is one of two absolute necessities. The other, unfortunately, is talent.

Ernest Hemingway

Modern self-assembly ( flat-pack) furniture is remarkable, leaving even the seasoned carpenter in a state of awe and confusion. Generally, it’s cleverly designed and will eventually build into what you expect it to.

When assembling it, you have to rely on the supplied instructions—you’ll build something more like modern art than furniture without them. The quality of the instructions drastically affects how easy construction is. Bad instructions make you sweat, swear, and continually take apart pieces of wood that should never have been attached in ...

Get Code Craft now with the O’Reilly learning platform.

O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.