What Is Good Presentation?
As you can see, good presentation means more than just being neat. Tidy code certainly gives an impression of high quality, but code can be both tidy and misleading. We strive for clear layout; the code structure must be enhanced by an indentation strategy, not hidden by it. If a particular flow of control is necessarily complex, the layout should be helping you to read the code. (If you’ve written a flow of control that is unnecessarily complex, you should change it immediately.)
Our code layout must convey meaning, rather than disguise it. I suggest the following as good metrics for the quality of a presentation style.
- Consistent
The indentation strategy must be consistent across the project. Don’t change styles halfway ...
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.
