PHPDoc Standards
| From: | Ant�nio" Carlos "Ven�ncio" "J�nior | Date: | Sat, 10 Aug 2002 20:49:29 +0000 |
| Subject: | PHPDoc Standards | ||
| Groups: | php.pear.dev | ||
| Request: | Send a blank email to pear-dev+get-8278@lists.php.net to get a copy of this message | ||
People,
I've started this week to help Derick on the development of PHPDoc. The
first thing I have in mind is to try to make a standard for PHPDoc
comments. That includes what tags to allow and how they should be done.
As soon we make a standard we can start to make a PHPDoc grammar.
Looking over the .php files under pear dir I've made a TAGS file that
includes 1914 tags found. If you look inside this file you will see how
"non-standard" are the comments. In example:
----------
http://www.organika.com.br/floripa/PEAR/TAGS
@return boolean , TRUE on success
@return boolean TRUE = success
@return boolean TRUE on success
@return boolean on success
----------
Which of these four is the correct syntax? =)
Please take a read in that file and send your comments about which tags
should be used and how. I'll make a file with all the tags avaiable at
CVS and some kind of tutorial about using them.
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]