http://www.perlmonks.org?node_id=225907


in reply to Re: Documenting Methods/Subs
in thread Documenting Methods/Subs

++!! This is the method I use as well. There are a few other guidelines I use:
  • More than 2 args, document the args so I remember what the hell I'm doing when I come back to the code in 6 months :)
  • Keep it short enough that a programmer can figure it out, and it doesn't take up to much screen space. If you need more than that, it should probably go in the help section.

    With that, and common sense, it is usually pretty obvious to me what I need to put in th comments.

    "Nothing is sure but death and taxes" I say combine the two and its death to all taxes!