Beefy Boxes and Bandwidth Generously Provided by pair Networks
Don't ask to ask, just ask
 
PerlMonks  

Re: How to document complex data structures?

by DrHyde (Prior)
on Oct 22, 2007 at 09:32 UTC ( #646401=note: print w/replies, xml ) Need Help??


in reply to How to document complex data structures?

I describe the structure in plain English and then give an example. I might say something like ...
The foo() function returns an arrayref, each element of which represents a bar that I have visited. Each bar is a hashref with the following keys: =head2 name, address, phone The bar's name, address and phone number =head2 good_beer An optional key, which if present will be a hashref of beers, whose keys are the beers' names and the values are the breweries that make them. =head2 cute_staff An optional key, which if present will be an arrayref (one element per cute staff member) of hashrefs, with keys 'name', 'sex', 'preferred_sex' and 'phone'. ... For example: [ { name => 'The Traditional Pub, address => '13 Wharf St, Workingclasstown', phone => '01234 567890', good_beer => { 'Tanglefoot' => 'Badger', 'Paradise Ale' => 'Theakstons', 'Special' => 'Youngs' }, cute_staff => [ # array in case there's two with the { # same name name => 'Jill', sex => 'F', preferred_sex => 'M', phone => '01234567899' } ... ] }, ... ]

Log In?
Username:
Password:

What's my password?
Create A New User
Node Status?
node history
Node Type: note [id://646401]
help
Chatterbox?
[1nickt]: I miss the days when you could customize every aspect of your PC on the Dell site.
[1nickt]: Or, just build one. (Actually I built a gaming PC for my son last year just like in the old days!)
[stevieb]: I remember the days where a consumer was allowed to have independent thought and choice too
[marioroy]: stevieb :)
[marioroy]: that is funny, made me smile. miss those days
[marioroy]: thank you, humor of the day stevieb++

How do I use this? | Other CB clients
Other Users?
Others contemplating the Monastery: (7)
As of 2017-03-26 18:50 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?
    Should Pluto Get Its Planethood Back?



    Results (315 votes). Check out past polls.