Re: Documentation Suggestion
| From: | Bertrand Mansion | Date: | Wed, 10 Sep 2003 11:10:53 +0000 |
| Subject: | Re: Documentation Suggestion | ||
| References: | 1 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-21340@lists.php.net to get a copy of this message | ||
<smith@backendmedia.com> wrote :
>> From: Tomas V.V.Cox [mailto:cox@idecnet.com]
>> Sent: Wednesday, September 10, 2003 12:20 PM
>
>>> Tomas V.V.Cox wrote:
>>>> [OFFTOPIC sorry]
>>>>
>>>> Is it possible to create a tool that once you have the code it'd
>>>> parse the .php files and fill the API Doc squeleton?
>>
>>> This tool exists and is called (surprise) phpDocumentor.
>>
>> Maybe I didn't express my self clearly, I'm talking about a tool that
>> create the PHPDoc skeleton comments for your uncommented source code.
>> Can phpDocumentor do that?
>
> Pretty much all PHP IDE's have this on their feature or todo list.
Still, I find Tomas' idea good. I have seen somewhere a php tool that will
reformat your code in order to make it more compliant with PEAR Coding
Standards. Another feature could be to reformat your PHPDoc comments or add
them automatically if they are missing, adding placeholders to be filled at
the same time. But it would have to leave the code untouched.
AFAIR, Zend Studio has its own comment style, not compatible with PHPDoc
(but that was a few months ago, so maybe they've changed that).
A tool like this would really be great !
(At least for me, I really have a problem with docbook).
Bertrand Mansion
Mamasam