Source Code Commenting


There's a fascinating look at the Win2k source code comments over at Kuro5hin today. I've written plenty of source code (only several thousand lines as opposed to tens of millions) but I've never commented my source code like they have. I guess I just operate in a very different corporate culture than Microsoft's.

My comments amount to explaining why I made choices I did, how a particular section works, and the purpose of different areas. They are at times humorous, mostly sterile, and never profane. I always assume that my co-workers are going to be reading them and that my boss might see it someday. I stay away from the redundant mode of commenting and try always to craft self-documenting code.


About this Entry

This page contains a single entry by bbrown published on February 16, 2004 4:38 AM.

RSS/ATOM/Whatever was the previous entry in this blog.

Guaranteed Winner is the next entry in this blog.

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

Feedback to