Question

Do you know about a tool to easily create documentation for both JavaScript and PHP code?

Something that takes comments in code similar to the one shown below:

/**********************************************************
This function does something special...

param1: ...
param2:

RETURNED VALUES:
...
**********************************************************/
function something(...)
{
   ...

And convert these into HTML files (maybe with a frameset menu on the left). Don't need for the same syntax shown above, it's only an example to explain of what I'm talking about.

Would like only one tool so once I learned the syntax to write documentation, i can use the same documentation syntax for both PHP and JavaScript.

It would be nice if the tool was a binary (.exe) or a Java code, with no need to install PERL or PYTHON.

Was it helpful?

Solution

Doxygen can handle PHP out-of-the-box, and helper scripts are available to enable its use with Javascript (this does require Perl, however).

OTHER TIPS

No offense, but the world of web development (especially PHP) is still a mainly Unix-based world. If you're automatically discounting anything that's based on Perl, Python, or another scripting language (like PHP!), your options dramatically drop, especially if you don't want to pay for it.

You should be able to install Perl binaries and then just run a script...

Licensed under: CC-BY-SA with attribution
Not affiliated with StackOverflow
scroll top