Re: coding standards: Header Comment Blocks
| From: | Stefan Neufeind | Date: | Sat, 12 Jun 2004 09:15:20 +0000 |
| Subject: | Re: coding standards: Header Comment Blocks | ||
| References: | 1 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-30550@lists.php.net to get a copy of this message | ||
On 8 Jun 2004 at 0:04, Stephan Schmidt wrote:
> > Klaus raised an interseting point on IRC regarding Header Comment Blocks.
> > For phpDocumentor to work correctly, we really need to have a page-level
> > docblocks.
> >
> > The current standard requires a regular comment at the top of each file:
> > http://pear.php.net/manual/en/standards.header.php
> >
> > Can we please modify the standard to make the header comments to be in
> > docblock format? I'd suggest the following for a standard file:
>
> I'd strongly welcome this change!
> The comments have been adopted from the PHP source and extensions but
> they make no real sense, when using PEAR.
Same here. Sounds reasonable to me.
Stefan