Re: PHPDoc Standards
| From: | Ant�nio" Carlos "Ven�ncio" "J�nior | Date: | Sun, 11 Aug 2002 12:42:58 +0000 |
| Subject: | Re: PHPDoc Standards | ||
| References: | 1 2 3 4 5 6 7 8 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-8291@lists.php.net to get a copy of this message | ||
Guillaume,
"Guillaume SMET" <guillaume.smet@ecl2002.ec-lyon.fr> wrote:
| The correct syntax of the PHPDoc tags is pretty well defined in the
| parser/PhpdocParserRegExp.php file. Some examples :
| "@parameter" => '@param[eter] (object objectname|type) [$varname]
| [description]',"@see" => '@see
| (function()|$varname|(module|class)(function()|$varname))
| [,(funtion()|$varname|(module|class)(function()|$varname))]',
|
| my 2 cents
True, but we cannot expect that a PEAR newbie or someone that is
starting to make PHPDoc comments to open the PHPDoc classes to know what
and how to do.
If you think in that way there is no need for the PEAR (and
packages) Manual, because if you open the files you will see what each
class does. ;)
Até
Antônio
"Can't buy what I want because its FREE!" - Pearl Jam
floripa@PHP.net | PHP & FreeBSD & MySQL | PGP Key ID 0x5BBEB073
Attachment: [application/pgp-signature]
Attachment: [application/pgp-signature]