Beefy Boxes and Bandwidth Generously Provided by pair Networks
We don't bite newbies here... much

Re: Re: Documenting Methods/Subs

by Rex(Wrecks) (Curate)
on Jan 10, 2003 at 18:42 UTC ( #225907=note: print w/ replies, xml ) Need Help??

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!

  • Comment on Re: Re: Documenting Methods/Subs

    Log In?

    What's my password?
    Create A New User
    Node Status?
    node history
    Node Type: note [id://225907]
    and the web crawler heard nothing...

    How do I use this? | Other CB clients
    Other Users?
    Others cooling their heels in the Monastery: (5)
    As of 2015-10-06 22:53 GMT
    Find Nodes?
      Voting Booth?

      Does Humor Belong in Programming?

      Results (163 votes), past polls