Re:Types of Comments to Avoid Making when Programming
by tjr on Saturday July 24, 2010 @06:30PM
(#1544529)
A few weeks ago I was perusing a code base that I had never seen before, consisting of some 100 subprojects, mostly written about a decade ago.
The code was mostly entirely uncommented. In a few files, it was heavily commented, but often strangely... such as allegorical comments relating the code to a magic act ("and now we shall make the volunteer vanish into thin air!"), or quotes from movies that loosely described the code.
The code was mostly entirely uncommented. In a few files, it was heavily commented, but often strangely... such as allegorical comments relating the code to a magic act ("and now we shall make the volunteer vanish into thin air!"), or quotes from movies that loosely described the code.