Beefy Boxes and Bandwidth Generously Provided by pair Networks
Problems? Is your data what you think it is?
 
PerlMonks  

Re: Re: Re: Writing Good Documentation

by ignatz (Vicar)
on Jun 25, 2002 at 17:41 UTC ( [id://177154]=note: print w/replies, xml ) Need Help??


in reply to Re: Re: Writing Good Documentation
in thread Writing Good Documentation

I've been very impressed with the way Bruce Eckel deals with it in his books. All of the examples are automatically built so that he can veryify that they actually compile.

Makes me start to think about a test/example system where the examples of a script are also some of it's tests. That way as you change your code the tests don't just point out errors in code but also where you need to update your examples to reflect changes in the code. Hmmmm.......

()-()
 \"/
  `                                                     

Log In?
Username:
Password:

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

How do I use this?Last hourOther CB clients
Other Users?
Others examining the Monastery: (2)
As of 2024-04-26 03:51 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found