RE: [PHP4BETA] Coding und documentation standards

From: Date: Mon, 14 Feb 2000 21:38:36 +0000
Subject: RE: [PHP4BETA] Coding und documentation standards
References: 1  Groups: php.dev php.version4 
Request: Send a blank email to php-dev+get-15525@lists.php.net to get a copy of this message
> 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

« previous php.dev (#15525) next »