views:

197

answers:

2

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 fucntion 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 sintax shown above, it's only an example to explain of what I'0m talking about.

Would like only one tool so once I learned teh sintax to write documentation, i can use the same documentation sintax 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.

Thanks.

A: 

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

Paul Dixon
A: 

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...

Jason Antman
I0m not discoutning PHP, I have it installed for my day time job. I'm lazy I don't have time now to install PERL and waste 1 week to understand how it works. Could you suggest a link with an easy tutorial on how to install it?
Marco Demajo
Well unfortunately I can't tell you a thing about how to run Perl on Windows. If you go to http://www.perl.org/get.html there are Windows binary installers. No need to understand "how" it works... it's just like any other scripting interpreter... open a command prompt, type "perl" followed by the name of the script, and it runs...
Jason Antman