Beefy Boxes and Bandwidth Generously Provided by pair Networks
No such thing as a small change

Re: Preferred method of documentation?

by bwelch (Curate)
on Oct 06, 2004 at 13:11 UTC ( #396971=note: print w/replies, xml ) Need Help??

in reply to Preferred method of documentation?

My rule for documentation is that I should be able to look over the code in a few years and see easily what the code does and whether all or parts of it is useful to any task at hand.

This leads me to a style similar to that of documenting new projects in sections:

  • Purpose: Summary of what the script does and why
  • Scope: Who is this for? Developers? Users? How much of whatever task is assumed versus handled?
  • Input and output requirements: XML input?
  • Dependencies: external programs, file formats, databases, embedded references to paths, etc.
  • Usage: How should I execute it?
  • Change history: This is more for keeping track of updates and debugging purposes but can be very helpful, especially so if more than one developer edits the script. This might be part of CVS or could be at the top of the script. An example:
    # 08/26/04 BW Changed doAssemblyJobs to read bait from file versus DB # 08/25/04 BW Added indexing and formatdb of gss files. # 08/17/04 BW Moved logic of into this script
For documention of individual functions that aren't completely obvious, I tend to add a couple lines of comments to indicate algorithms or other unusual behavior. With good variable names, this isn't needed much. An example:
# Generic job monitor for watching jobs finish. # - No action is taken when each job finishes. # - Function returns when all jobs have finished. # - Inputs: A hash of job IDs from LSF # - Returns: No specified return code

One thing I try to remember is that while things may seem obvious while writing and testing the code, a year or so in the future they won't be. Commenting with that in mind has helped me out in many situations.

Log In?

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

How do I use this?Last hourOther CB clients
Other Users?
Others taking refuge in the Monastery: (5)
As of 2023-11-30 07:22 GMT
Find Nodes?
    Voting Booth?

    No recent polls found