documentation

From: Date: Mon, 07 May 2001 08:46:14 +0000
Subject: documentation
Groups: php.pear.dev 
Request: Send a blank email to pear-dev+get-351@lists.php.net to get a copy of this message
Hi all, For a while i've been feeling the need to post some critique but i have been hesitant to do so since I haven't really contributed anything to the PEAR project yet. But I figured i'd do it anyway ;-) My critique is about the documentation. Having API-docs for a class is an absolute necessity, but I'm sure nobody disagrees with me on this. There's something else missing: a manual-page (with examples) for every class. Imagine your first steps into PHP without all those examples in the PHP manual. And those are only functions. Using classes is ofcourse a little more complex (but easier once you understand them). Therefore I think that *every* class put into PEAR should have both decent PHPDoc documentation directives (for the API) PLUS a manual file. This will vastly help people to make their first steps into using PHP. Understanding a class just by its interface is rather difficult except for the programmer of the class himself. I'm curious about what all you codes think about this. I know that lots of programmers generally feel that documenting their work is dull etc etc... Let's see what things are at in here ;-) Byebye, Hans

« previous php.pear.dev (#351) next »