Commenting code revisited.

[mystran]

I tried to collected some wisdom from the latest "Commenting code" thread into an "article" of some kind. It mostly constains my own thought, but I also added some quotes from the thread. Other than some trivial typographic corrections, they are as posted here.

If any of you (CloudNine, Curufir, Solar and Joel at present) find it offensive to get quoted, then please inform me and I will edit the document to replace those quotes.

http://www.cs.hut.fi/~tvoipio/commenting.html

[Solar]

I feel honored to be quoted this way.

[CloudNine]

Wow! I'm famous (wipes tear from eye ). I've got no problems with being quoted.

[Tora OS]

Nice article. Perhaps I will learn some things instead of having a piece of code like this:

Code: Select all

void main();
{
//do the intial crap.
vc_init();
kbd_start();
vc_puts("Kernel finished....",1);
}