This post originated from an RSS feed registered with Ruby Buzz
by Lyle Johnson.
Original Post: Mike Clark on Sweet-Smelling Comments
Feed Title: Lovable Lyle
Feed URL: http://feeds.feedburner.com/LovableLyle
Feed Description: This weblog typically features articles about the Ruby programming language, the Semantic Web, or whatever else is on Lyle's mind on a given day.
A recent article from Mike Clark presents some good advice about comments:
Keep It DRY. The "Don't Repeat Yourself" principle has wider application than the mere avoidance of code duplication. It's also a mistake to duplicate knowledge about the intent or functionality of a method in the source code's comments. As Mike notes, "If a comment already describes what the code does, then the comment is
Previous Topic
