Re: Documentation and UML diagrams

From: Date: Fri, 30 May 2003 05:17:39 +0000
Subject: Re: Documentation and UML diagrams
References: 1 2  Groups: php.pear.dev 
Request: Send a blank email to pear-dev+get-16823@lists.php.net to get a copy of this message
-----BEGIN PGP SIGNED MESSAGE----- Hash: SHA1 Jesus M. Castagnetto, el jueves 29 de mayo a las 22:09 me escribiste: > BTW, Autodia now generates GraphViz and VCG > (http://rw4.cs.uni-sb.de/users/sander/html/gsvcg1.html), and PHP support seems > OK so far. Doxygen is nice, but I got used to the javadoc style from writing > Java code for mangling protein structures. It supports JavaDoc. It's very similar to PHPDoc comments too (well PHPDoc is very similar to JavaDoc :) so PHPDoc documented code can be interpreted by Doxygen preety well (it lacks of some features like @access). > Indeed, I do have Umbrello and ArgoUML on my machine too ;-). I was not too > happy w/ the PHP code from Umbrello, the Java code for that one and ArgoUML > seems adequate for de novo code. Apropos, there are several 'dialects' of XMI > AFAICT, to the point that there are xmi->xmi converters. Had not tried > xmi2code, but usually my problem is the documentation of stuff I wrote some > time ago, so I am not sure if I would personally use it much. I wrote xmi2code PEAR compatible generator and it's working preety well. They key feature is that it let you mantein the code (specially inline documentation that is generated from the Diagram) thanks to the roundtrip generation, so if you keep the diagram well documented and updated, you have a well documented code for free :). All you have to do is xmi2code -a to update your code when you change the UML diagram. - -- LUCA - Leandro Lucarella - Usando Debian GNU/Linux Sid - GNU Generation - ------------------------------------------------------------------------ E-Mail / JID: luca@lugmen.org.ar GPG Fingerprint: D9E1 4545 0F4B 7928 E82C 375D 4B02 0FE0 B08B 4FB2 GPG Key: gpg --keyserver pks.lugli.org.ar --recv-keys B08B4FB2 - ------------------------------------------------------------------------ <Delenn> I wouldn't make it through 24 hours before I'd be firing up the grill and slapping a few friends on the barbie. <spacemoos> Why would you slap friends with barbies, thats kinda kinky -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.2.2 (GNU/Linux) iD8DBQE+1ulzSwIP4LCLT7IRAmu1AJsFbBklAEwMqzOcme6+fd4KdXuZdgCgry5J EBanwc0JgkirW5vdVAfjWXU= =2r9p -----END PGP SIGNATURE-----

« previous php.pear.dev (#16823) next »