|
|
Posted by Chris Hope on 05/12/05 08:38
Mike Willbanks wrote:
> anthony,
>
>> Some of the key points I am looking at personally include:
>> 1) Long term viability of the solution chosen. This could be offset
>> by the compatibility of the tags with other products.
>> 2) Ease to get existing code documented to the chosen standard
>> 3) Ease to document future code
>> 4) Quality/flexability of the tool chosen
>>
>> Anyway, which opensource documentation tool do you recommend and why?
>> Please indicate in responses which you have experience with.
>
> Personally I use PHPDocumentor. One because of the support it has
> with
> the tags alone are normally far better than the others. The tags
> itself works with the svn/cvs tags as well ie (@version).
>
> The ease of using PHPDocumentor is insanely easy. Although it may
> take a little bit to actually get used to it and understand it as most
> documenting programs do, but if you are at all familiar with JavaDoc
> you will run right into it fine.
>
> To document future code is extremely easy, and even if you deprecate a
> function there are tags for that as well! Also tags to show that this
> function was available since a certain date.
>
> The quality and flexibility in my mind is amazing, there is only one
> thing more that I want is to be able to have inline code examples
> generated if more than one exists.
If you use latest version of the Zend Studio it also uses any
PHPDocumentor tags in your code to show help as you are coding, and
also to help with code completion. It's helped to make me a lot more
productive.
--
Chris Hope | www.electrictoolbox.com | www.linuxcdmall.com
Navigation:
[Reply to this message]
|