Author : Dustin Boswell,Trevor Foucher
Publisher : "O'Reilly Media, Inc."
Page : 204 pages
File Size : 42,6 Mb
Release : 2011-11-03
Category : Computers
ISBN : 9781449321383
The Art of Readable Code by Dustin Boswell,Trevor Foucher Pdf
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.