Re: Re: PEAR Quality (vs. Quantity) RFC

From: Date: Wed, 14 May 2003 19:38:08 +0000
Subject: Re: Re: PEAR Quality (vs. Quantity) RFC
References: 1 2 3 4 5 6  Groups: php.pear.dev 
Request: Send a blank email to pear-dev+get-16255@lists.php.net to get a copy of this message
Davey wrote:
no, but the choice of its non-standard doc tags is pretty random. It's really too bad, as you will find that the documentation tags are useless for anything but development in ZDE.
The only non-standard tag it uses is @desc, it in fact only recognises: @desc @param @return anything else is ignored (so I can put in everything else for apidoc and it will just ignore them). Is it at all possible for phpDocumentor to support that one discrepency as I believe the ZDE is a very liked editor, mainly because its cross platform and it fully supports the PHP syntax... and its auto-complete works off the apidoc :)
Just think the other way round: The PHPDoc syntax is considered to be "the standard". phpDocumentor, an open source tool that is available for free, already supports this standard. Why should the maintainers of this tool bother to support one IDE that doesn´t comply to the standard? Wouldn´t it make more sense to ask Zend to change the way their IDE behaves? At least they´re getting paid - by us! - to do it, so we should be able to demand such things from them. I like the ZDE (I own a copy), but I don´t like the @desc tag. Also, there are other tools than phpDocumentor that can generate API docs: PHPEdit, another IDE, has a doc generator. PHPEdit does not use @desc. One last argument: The PHPDoc syntax is derived (if not copied) from the JavaDoc syntax. JavaDoc is regarded as *the* industry standard for inline docs by developers word-wide. Do they have the @desc tag? I did a quick search and didn´t find it, so my guess is: "No". Regards, Markus

« previous php.pear.dev (#16255) next »