Messages in this thread |  | | From | Mike Harrold <> | Subject | Re: [OT?] Coding Style | Date | Mon, 22 Jan 2001 11:19:53 -0500 (EST) |
| |
> > > -----Original Message----- > > From: profmakx.fmp [mailto:profmakx.fmp@gmx.de] > > > > So, every good programmer > > should know where to put comments. And it is unnecessary to > > put comments to > > explain what code does. One should see this as stated in the > > CodingStyle doc. > > Ok, there are points where a comment is good, but for example > > at university > > we are to comment on every single line of code ... > > WRONG!!! > > Not documenting your code is not a sign of good coding, but rather shows > arrogance, laziness and contempt for "those who would dare tamper with your > code after you've written it". Document and comment your code thoroughly. > Do it as you go along. I was also taught to comment nearly every line - as > part of the coding style used by a large, international company I worked for > several years ago. It brings the logic of the programmer into focus and > makes code maintenance a whole lot easier. It also helps one to remember > the logic of your own code when you revisit it a year or more hence. >
There is an old programmer's rule.
"Documentation? Too bad. If the code was damned hard to write, it should be damned hard to understand."
:)
/Mike - To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to majordomo@vger.kernel.org Please read the FAQ at http://www.tux.org/lkml/
|  |