#20066 [Opn->Csd]: [Feature] PHPDoc dependency on *'s
| From: | mj@php.net | Date: | Fri, 14 Feb 2003 11:00:17 +0000 |
| Subject: | #20066 [Opn->Csd]: [Feature] PHPDoc dependency on *'s | ||
| References: | 1 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-13261@lists.php.net to get a copy of this message | ||
ID: 20066
Updated by: mj@php.net
Reported By: mattb@columbia.edu
-Status: Open
+Status: Closed
Bug Type: PEAR related
Operating System: GNU/Linux 2.4.18-17.7.x (RedHat)
PHP Version: 4.2.3
New Comment:
It's just a convention and it's done in Javadoc (where PHPDoc has
borrowed most of it's features from) in the same way.
Previous Comments:
------------------------------------------------------------------------
[2002-10-24 13:27:26] mattb@columbia.edu
Not sure if this is the correct forum for reporting PEAR bugs, but here
goes...
It seems like if the leading ' * 's are missing from the body of a
PHPDoc comment, some information will be lost (namely the @... tags).
For example, the following comment will not have an author or package:
/**
This is my class. There are many like it, but this one
is mine.
@author Me <me@myself.org>
@package my_package
*/
However, this one works fine:
/**
* This is my class. There are many like it, but this one
* is mine.
*
* @author Me <me@myself.org>
* @package my_package
*/
Is there any reason why the *'s are required? Can the be made to be
optional (comments are much easier to edit if they're not forced to be
there)? Just my two cents....
------------------------------------------------------------------------
--
Edit this bug report at http://bugs.php.net/?id=20066&edit=1