On Wed, Oct 30, 2013 at 4:08 PM, Ed Leafe <[email protected]> wrote:
> On Oct 30, 2013, at 2:47 PM, Stephen Russell <[email protected]> > wrote: > > > http://visualstudiomagazine.com/articles/2013/06/01/roc-rocks.aspx > > > > Article is Why You Shouldn't Comment (or Document) Code > > Geez, I keep seeing this same tired argument, especially from the Ruby > crowd. > Indeed! One of my pet peeves with the Ruby community is the lack of commenting. However, quoting from the fine article: "Let's say you modify some application based on the comments you find in the code. You then put your changes into production, and discover that there was some essential component that the comments failed to mention. " That's asinine! You make code changes BASED ON THE COMMENTS? Then you put them into PRODUCTION with no TESTING? You get what you deserve. Yes, stupid comments should not be in your code. You should choose your > names to indicate what the code does. Your comments should be for the edge > cases where the expected behavior is not desired, for whatever reason that > might be. You can save your successors a great deal of grief with a simple > note as to why the obvious road was not taken; you simply cannot do that > with a test. > Comments need to be refactored, just like code. I bookmark many of my changes when they are brand new, just because the chance that they'll break something is a lot more likely. Next time I'm through the code for another purpose, out go the old comments. They're in source control anyway, should the need arise. -- Ted Roche Ted Roche & Associates, LLC http://www.tedroche.com --- StripMime Report -- processed MIME parts --- multipart/alternative text/plain (text body -- kept) text/html --- _______________________________________________ Post Messages to: [email protected] Subscription Maintenance: http://mail.leafe.com/mailman/listinfo/profox OT-free version of this list: http://mail.leafe.com/mailman/listinfo/profoxtech Searchable Archive: http://leafe.com/archives/search/profox This message: http://leafe.com/archives/byMID/profox/cacw6n4vxak7wh8rfag2-zuacyxigq8mdpx4rbu-z+fttmg0...@mail.gmail.com ** All postings, unless explicitly stated otherwise, are the opinions of the author, and do not constitute legal or medical advice. This statement is added to the messages for those lawyers who are too stupid to see the obvious.
