Stories
Slash Boxes
Comments

NOTE: use Perl; is on undef hiatus. You can read content, but you can't post it. More info will be forthcoming forthcomingly.

use Perl

All the Perl that's Practical to Extract and Report

Code Comments: To be Read or Scanned? More | Login | Reply

The Fine Print: The following comments are owned by whoever posted them. We are not responsible for them in any way.

Without JavaScript enabled, you might want to use the classic discussion system instead. If you login, you can remember this preference.

Comments on...uh, comments (Score:1)

by chaoticset (2105) on 2001.12.05 11:29 (#2122) Homepage Journal

I've kind of fallen into an odd trap. I comment the hell out of the space *just before* something, and then I put little comments in when I figure it's not clear what's where and where's what.
That is, I explain what's supposed to be going on (mainly to myself so I'll remember later) and then, if the code is particularly long or arduous or uses lots of functions I don't understand, I comment specific lines. I try to avoid that, though.
Of course, this is code for *me*, at this point. When I get it cleaned up, I'll likely rip most of the comments out, leave the little pointers, and give an overview at the beginning. (Hell, I may get ambitious and put POD in there, too. You never know.)

--

------------------------------
You are what you think.

Reply to This

Get More Comments

Stories, comments, journals, and other submissions on use Perl; are Copyright 1998-2006, their respective owners.