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.

All the Perl that's Practical to Extract and Report

use Perl Log In

Log In

[ Create a new account ]

autarch (914)

autarch
  (email not shown publicly)
http://www.vegguide.org/

Journal of autarch (914)

Monday March 10, 2003
10:41 PM

Re-reading docs

[ #10978 ]

No, not other people's, my own.

I've found that periodically re-reading the docs of my modules is a good habit, as it helps me spot typos and thinkos that have gone unreported, as well as outright mistakes and holdovers from past versions which should have been changed but weren't.


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

Re-reading docs 2 Comments More | Login | Reply /

 Full
 Abbreviated
 Hidden
More | Login | Reply
Loading... please wait.
  • It's my theory that my brain gets entirely replaced every three months. That's about how long it is before my code doesn't make sense without comments or additional documentation. That's how long I remember why I was being particularly clever. That's why it's important to put comments on things: it's not just for the next guy, it's for me three months from now.

    And as you're seeing, that's how long it is before you're a "fresh reader" on a doc. Yes, good idea to go back, with your new brain. Three months.

    --
    • Randal L. Schwartz
    • Stonehenge
    • That's about how long it is before my code doesn't make sense without comments or additional documentation.

      Luckily, a lot of your code comes with a column's worth of commentary. You get to rediscover what you were thinking along with the rest of us.

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