Re: coding standards: Header Comment Blocks
| From: | Aidan Lister | Date: | Fri, 18 Jun 2004 10:02:32 +0000 |
| Subject: | Re: coding standards: Header Comment Blocks | ||
| References: | 1 2 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-30900@lists.php.net to get a copy of this message | ||
Any movement on this?
"Stefan Neufeind" <stefan@neufeind.net> wrote in message
news:40CAE5C8.17127.AC10CE@localhost...
> 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