Software documentation / Class Diagrams?

[redletterrocko]

Hi all,

I recently started a new job, and find myself caught in the middle of a rather complicated php project. I've spent the last week and a half trying to figure out exactly how everything works, but it's a longer task than I thought. I've tried to document functions in each .php file, etc, but it's a slow and dreadful process. I was wondering if anyone else has gone through this, and whether or not you knew of any scripts that might be able to fire out all the functions from a specirfic .php file, and maybe even the variables passed, etc, much like a UML class diagram in Java. Any ideas?

 

[jpadie]

there is a php documenter published in the PEAR repository. i've always wondered what it did (aside from the obvious "documenting php" and have suspected it does some rudimentary code analysis and documentation, much like the VB equivalent published by MS. I've never tried it though. might be worth a look. you might also find a documentation class on hotscripts.

no automated task is likely to be a panacea though. if you want some decent documentation produced you might consider posting a bid on rent-a-coder or similar.

 

[KingCrab]

phpdoc is great

http://www.phpdoc.org/