Source Code Commenting Technique

Published 20 February 04 02:21 PM | alexcampbell

This article has cast a new light on how fun commenting source code can be... everyone just has to remember to be really careful not to leave <compilation debug=“true” /> on any live sites.  Imagine this scenario:

Compilation Error

Description: An error occurred during the compilation of a resource required to service this request. Please review the following specific error details and modify your source code appropriately.

Compiler Error Message: CS1585: Request too stupid.

Source Error:

Line 35:   /// Implements client's fucking stupid idea of having giant purpledots all
Line 36:   /// all over the fucking page
Line 37:   /// </summary> 
Line 38:   public void WriteBigPurplePokaDots(int DotSize, string )
Line 39:   {
Line 40:     PurplePokaDotWriter myDotWriter = new PurplePokaDotWriter();

In the meantime, I'm not sure why MSFT is so worried about people downloading files like “windows_2000_source_code.zip” from Kazaa.  Everyone knows that the content of files on Kazaa has no correlation to the titles and descriptions of those files.  Potential MS source-code readers are more likely to waste 200mb of their download allowance and then discover that they have downloaded a renamed archive of really wierd stuff.  Which serves them right.

Comments

# Jerry Pisk said on February 20, 2004 03:38 AM:

If you write comments like that you should see a therapist. All coders I know take their issues out in UT.

# Alex Campbell said on February 25, 2004 06:22 AM:

I try to take my issues out in UT, but I'm not very good at it. I get so stressed about losing that I give up and go for a walk.

# Alex Campbell said on February 25, 2004 06:22 AM:

I try to take my issues out in UT, but I'm not very good at it. I get so stressed about losing that I give up and go for a walk.