Beefy Boxes and Bandwidth Generously Provided by pair Networks
Perl: the Markov chain saw
 
PerlMonks  

Re: Large-scale code documentation

by ggg (Scribe)
on Nov 05, 2004 at 15:21 UTC ( #405516=note: print w/replies, xml ) Need Help??


in reply to Large-scale code documentation

I don't know enough to give any examples, but from what I've read in other threads, it might be a good idea to develop a test suite that the present code passes. If your updated code still passes, you can have some assurance that you haven't bollixed things up too badly. :-)
ggg

Replies are listed 'Best First'.
Re^2: Large-scale code documentation
by deprecated (Priest) on Aug 13, 2007 at 16:41 UTC
    You can use Class::Contract and Params::Validate to create a syntax of "how stuff should work," from which you can write a lexer to create documentation for. Hardish work, but very rewarding when it works.

    --
    Tilly is my hero.

Log In?
Username:
Password:

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

How do I use this? | Other CB clients
Other Users?
Others examining the Monastery: (1)
As of 2021-10-19 03:55 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?
    My first memorable Perl project was:







    Results (76 votes). Check out past polls.

    Notices?