Commenting your code may not be a good idea

| | Comments (4)
While most people are encouraged to comment code in any programs or scripts that they produce you may want to revisit that concept now.... Why? Well imagine if someone left a comment that wasn't that flattering in the midst of it all. For example: "the user is a w**nker" I'm sure we've all done it :) I haven't ever written that much code, so I'm less likely to have (thankfully!) See full story - and who said Apple were boring? :)
digg| bookmark

Categories

, ,

4 Comments

winds said:

Commenting your code is fine. But this is not code commentary - it's messing, childish and immature. Part of me is not surprised, however.

Why castigate good and useful commentary because of some idiots? My code commentary is for the benefit of the person coming after me and having had to maintain uncommented code I attach a great deal of importance to decently documented code.

Ken McGuire said:

There was a time when I was a little humourous with code commenting but I'll try stick to the point now.... Most of the time its notes to myself as much as other people but it all helps!

Chris Byrne said:

I remember a colleague who used to use "Do until hell freezes over" in his code (many many years back, I might add) A quick search shows this is still common practice. But seriously, commenting is a key documentary aid and can add elegance to well crafted code. No place for wisecracks.

David Neylon said:

I'd have to say commenting your code is a must but definitely keep the personal comments out. I've spent too much time wading through somebody else's thought processes not to appreciate good comments.

Michele Neylon - cartoon picture

About this Entry

This page contains a single entry by Michele Neylon published on October 16, 2006 1:59 PM.

Golden Spiders 2006 - Not all paid this time! was the previous entry on this site.

Microsoft To Break The Internet (again!) is the next entry on this site.

Find recent content on the main index or look in the archives to find all content.

Powered by Movable Type 4.1