Re: Re: phpdoc and web services

At 07:34 PM 1/28/02 -0600, Lux wrote:

I tend to agree, although XML docs tend to be much more long-winded than PHPdoc, but I'm not sure if that matters.

It depends if you're going to remove the comments from the source before using it in production. Otherwise you're in the situation of large file sizes which means longer read times for the files.

They're also a little less readable. For instance, if you stick XML docs throughout your code, then you can end up with a case where you're sticking PHP inside HTML (we know better than that, but still), then you're sticking XML inside your PHP, then if you want examples, well, toss in a CDATA section and put some more PHP into it, and it just seems a little recursive and messy.

Agreed. The current javadoc implementation is nice and easy to read when browsing the source, and the addition of XML tags instead would, IMO, make it harder to read. Just my £0.02, Peter. -- Maple Design - http://www.mapledesign.co.uk