Re: Re: coding standards: Header Comment Blocks
| From: | Paul M Jones | Date: | Tue, 08 Jun 2004 00:26:01 +0000 |
| Subject: | Re: Re: coding standards: Header Comment Blocks | ||
| References: | 1 2 3 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-30114@lists.php.net to get a copy of this message | ||
On Jun 7, 2004, at 7:17 PM, Alan Knowles wrote:
Personally I find phpdocu output 'pretty', but absolutely and totally useless..Heh. I know just what you mean. Almost easier to read the code directly, sometimes -- but sometimes it's nice to look at a web page.
the comment blocks in the code however are very useful. I do not think that should be mandatory - but changing the example in the manual sounds reasonable..I think we're auto-generating API documentation on all packages now (not sure on this ... yes, looks like it). For that reason, I think top-level doc-blocks make sense and thus should be "very strongly recommended", but as ever, that's just me. :-) -- Paul M. Jones Savant: the simple alternative to Smarty for PHP. http://phpsavant.com/ DB_Table: build RDBMS tables and XHTML forms in one PHP class. http://wiki.ciaweb.net/yawiki/index.php?area=DB_Table Yawiki: your collaborative online documentation system. http://yawiki.com/ Yawp: a single-file foundation for PHP applications. http://phpyawp.com/