The Art of Readable Code

Download or read book The Art of Readable Code written by Dustin Boswell and published by "O'Reilly Media, Inc.". This book was released on 2011-11-03 with total page 204 pages. Available in PDF, EPUB and Kindle. Book excerpt: Chapter 5. Knowing What to Comment; What NOT to Comment; Don't Comment Just for the Sake of Commenting; Don't Comment Bad Names--Fix the Names Instead; Recording Your Thoughts; Include "Director Commentary"; Comment the Flaws in Your Code; Comment on Your Constants; Put Yourself in the Reader's Shoes; Anticipating Likely Questions; Advertising Likely Pitfalls; "Big Picture" Comments; Summary Comments; Final Thoughts--Getting Over Writer's Block; Summary; Chapter 6. Making Comments Precise and Compact; Keep Comments Compact; Avoid Ambiguous Pronouns; Polish Sloppy Sentences.