Re: [PHP4BETA] Coding und documentation standards

I agree. I think it would be nice to have either a switch to the PHP binary (CGI version of course) or a separate binary like javadoc that parses the code for comments and displays them in a readable format. Probably doesn't necessarily need to get as detailed as javadoc though. Using something like this would make entering comments in XML a little more readable since they would be formatted by the binary. Heck, something like this could easily be written in PHP itself. -D ----- Original Message ----- From: Leon Atkinson <leon@clearink.com> To: Ulf Wendel <UW@NetUSE.DE>; <php-dev@lists.php.net>; <php4beta@lists.php.net> Sent: Monday, February 14, 2000 4:38 PM Subject: RE: [PHP4BETA] Coding und documentation standards > > So, is anybody working on coding and documentation standards? > > I have a style guide for PHP code, and part of it is to put > well-formatted comment blocks at the top each every file > and above function definitions. That Java is so structured > in the first place makes Javadoc a little easier than a > similar system for PHP, but it shouldn't be too hard. > > For example, the function headers I've been writing look > like this: > > /* > ** Function: addToLog > ** Input: STRING message, INTEGER severity > ** Output: none > ** Description: Puts a message in the log > */ > > It might be kind of cool to have comments written in XML, though. > > /* > <function name="addToLog"> > <input name="message" type="string"> > <input name="severity" type="integer"> > <description>Puts a message in the log</decription> > </function> > */ > > I'm not sure that's as readable. > > Anyway, I'm very interested and willing to help out. > > Leon > > -- > PHP 4.0 Beta Mailing List <http://www.php.net/version4/> > To unsubscribe, e-mail: php4beta-unsubscribe@lists.php.net > For additional commands, e-mail: php4beta-help@lists.php.net > To contact the list administrators, e-mail: php4beta-admin@lists.php.net >