Re: Documentation

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Wed, Oct 27, 2010 at 2:20 PM, Nicholas Kell <nick@xxxxxxxxxxxxxxxx>wrote:

>
> On Oct 27, 2010, at 4:09 AM, Tommy Pham wrote:
>
> >> -----Original Message-----
> >> From: Jordan Jovanov [mailto:jovanovjoce@xxxxxxxxx]
> >> Sent: Wednesday, October 27, 2010 1:53 AM
> >> To: php-general@xxxxxxxxxxxxx
> >> Subject:  Documentation
> >>
> >> Hello All,
> >>
> >> I finished with coding and now I am on the part when need to write
> >> documentation. But I don't know how to write correct documentation.
> >> Does have some rules or standard for writing documentation for PHP?
> >> Or maybe have some programs for writing documentations?
> >>
> >> Best Regards,
> >> Jordan JOVANOV
> >>
> >
> > Jordan,
> >
> > I believe the standard is still phpdoc.org.  If you're on Windows and
> use
> > phpDesigner, it has a nice built-in phpDocumentor to cover your basic
> > documentation.  I don't know about other IDEs.
> >
> > Regards,
> > Tommy
> >
> >
> > --
> > PHP General Mailing List (http://www.php.net/)
> > To unsubscribe, visit: http://www.php.net/unsub.php
> >
>
>
> As for IDE's I have used Netbeans. It autocompletes some of the function
> headers for you as soon as you enter /** and hit enter, when directly above
> a function, method or class. The things that it will autocomplete for you
> are: params with names, and an @return if a return statement is present.
>
> After I use NB for putting in headers I usually use phpdoc as mentioned.
> Aptana has PHPDoc built into it.
> --
> PHP General Mailing List (http://www.php.net/)
> To unsubscribe, visit: http://www.php.net/unsub.php
>
> I use doxygen with eclipse. Eclipse fills automatically some fields like
netbeans. Doxygen is easy to use with the GUI and once you learned to use
it, you can use it for java,C++ etc...

[Index of Archives]     [PHP Home]     [Apache Users]     [PHP on Windows]     [Kernel Newbies]     [PHP Install]     [PHP Classes]     [Pear]     [Postgresql]     [Postgresql PHP]     [PHP on Windows]     [PHP Database Programming]     [PHP SOAP]

  Powered by Linux