in reply to Re: The sourcecode *is* the documentation, isn't it?
in thread The sourcecode *is* the documentation, isn't it?
So let's say there were functions like _alex_weird_add() and _alex_weird_multiply(). Definitely private functions because they performed tasks that weren't "add" or "multiply." I didn't want the user using them, I didn't want them exposed to the rest of the API, but I needed to make sure that somebody down the line (there is always churn in software shops) would be able to read my POD (and in this case my Params::Validate clauses too) and be enlightened.
To suggest that not having the documentation somehow makes the reader of the code ... less in the dark just seems entirely to miss the point of documentation.
--
Tilly is my hero.
|
---|
Replies are listed 'Best First'. | |
---|---|
Re^3: The sourcecode *is* the documentation, isn't it?
by dragonchild (Archbishop) on Sep 11, 2007 at 01:31 UTC |