Documenting an existing website (symfony)

Question

Hi,

I need to document a web application which wasn't built by me. It was built in symfony.

The documentation needed is code documentation, including list/description of classes, components etc and their interdependencies. At the moment the code isn’t commented much and the way it has been commented is inconsistent.

I was thinking of using Doxygen to generate initial documentation and then take it from there.

Any other suggestions?

Thanks in advance.

Mark.

Answer 1

As it's PHP you could look into commenting the code with PHPDoc blocks, it's what we use for API documentation and can, if you use type hinting in function definitions, give you some idea of interdependencies.

On top of that you'll also want a hand-written high-level overview of the major parts of the app, what methodology was used, what certain parts expect as input and give as output etc.