Dead Journal Dead Journal Dead Journal




Enter the Crypt
    - OpenID

The Cemetery
    - The Morgue
    - Join the Undead
    - Offerings
    - Download
    - DJ News
    - Advertise on DJ

Morgue Directory
    - Random Grave
    - Place of Death
    - Search Morgue
    - Interests

Botched Murders
    - FAQ
    - Lost Info?
    - Spoon Feeding
    - Hauntings





dglenn ([info]dglenn) wrote,
@ 2009-10-31 12:40:00

Previous Entry  Add to memories!  Tell a Friend!  Next Entry
I may be overcommenting

Is this over-commenting / a sign that I didn't sleep well enough last night? I just wrote, in a C program:

    int     i;                     /* Ye olde generick loope counter (you  */
                                   /* do know that the 'Y' in "ye olde" is */  
                                   /* really supposed to be a _thorn_, so  */
                                   /* it's still pronounced "the old" not  */
                                   /* "yee old" right?  Well you do now.   */
                                   /* Not sure what most C compilers would */
                                   /* do with a non-ASCII character in a   */
                                   /* comment though.  But I digress ...)  */

I do seem to comment more extensively after trying to read almost anybody else's code, where I'm lucky to find comments describing a function's purpose, much less any explanation of its arguments or useful clues as to where I need to poke at it to add a feature. And I've been reading other people's code lately.

Obviously, this is code I'm planning to send to a bunch of other people ... (But while I'm posting -- do other compilers supply the __FILE__ and __DATE__ pre-defined macros, or is that just a gcc thing? I don't know what Windows users will compile this with.)



(Read comments)

Post a comment in response:

From:
(will be screened)
Help (will be screened)
Identity URL: 
Username:
Password:
Subject:
No HTML allowed in subject
  
Message:

Terms of Service  |   Private Policy  |   Site Options  |   Login/Logout/OpenID

© 2001-2009 DeadJournal, A Service of Warped, Inc. - All Rights Reserved.