Hi Guys, On that PHP doc note I thought you might be interested in a UML modelling tool called Enterprise <http://www.sparxsystems.com.au/> Architect that can forward engineer PHP code structure form UML class diagrams and reverse engineer UML diagrams from existing code. It includes PHPdoc generation as part of the tool set and will automatically create/add PHPdoc comments to generated/existing code based on the comments in the static class diagram objects and elements.
It also will model DB schema by importing the structure from the DB itself through ODBC for example and can create the SQL from the data modal diagram for updating/creating the DB. Great if you have existing code but no class diagrams or documentation, import your code to create the statics class diagram objects and create your html phpdoc files all with the click of a couple of buttons. Update your class diagrams or add additional comments to you documentation and update your code using the generate code tool. The old code is not affected but the new comments or objects and functions skeleton structure is added. Very handy, I have imported a couple of historical projects and it has been brilliant! If doing it from scratch you can just create your use cases, activity diagrams and what every else, create your static class diagrams with commenting and generate all the code structure that is fully commented with the click of a button. The complete file and object structure skeleton is there and all that is required then is to flesh out the function content. Major saving in time and documentation quality. UML tools are incredibly easy to work with in EA and I found I had it up and running and usable without having to read a single help file so it is quite intuitive. It also supports collaboration and lots of other cool stuff I haven't even looked at yet. (maybe I should try and get commission lol) Cheers, Andrew -----Original Message----- From: [email protected] [mailto:[email protected]] On Behalf Of Aaron Cooper Sent: Wednesday, 11 February 2009 10:51 a.m. To: [email protected] Subject: [phpug] Re: PHPDoc Syntax Thanks Mark, That appears to work alot better. Two seperate doc blocks are required. Cheers Aaron ----- Original Message ----- From: "Mark Rickerby" <[email protected]> To: <[email protected]> Sent: Wednesday, February 11, 2009 10:37 AM Subject: [phpug] Re: PHPDoc Syntax > > You generally need a page level docblock to come before the class > level docblock... > > <?php > /** > * (c) statement etc > * @package myapp > */ > require_once 'somefileineed.php'; > > /** > * Main class docblock > * > * More here > * > * @abstract > */ > class MyClass ... > > > However, it should work fine without... I have never run into any > problems with this... > > > --~--~---------~--~----~------------~-------~--~----~ NZ PHP Users Group: http://groups.google.com/group/nzphpug To post, send email to [email protected] To unsubscribe, send email to [email protected] -~----------~----~----~----~------~----~------~--~---
