Re: Re: coding standards: Header Comment Blocks

On Wed, Jun 09, 2004 at 09:47:14AM +0200, Tobias Schlitt wrote: > stuff sounds even good to me. I'm not sure, if we can simply change that, or > minimally should have a kind of "pseudo-vote" here on the list, therefore, > I'd like to have a little new thread, explaining what we wanna do and having > people replying with their +/-1. > > Anyo objections to that? Not at all. But we need to get a basic idea of what we're going to vote for before we vote, please. The two things that need clarifying are what the tags should look like and then how the substitution process happens. From reading everyone's comments, it seems the following abbridged docblock example may come closest to a concensus: /** * @version Release: @package_version@ * @version CVS: $Revision$, $Date$ */ So, Greg, is this valid in phpDocumentor? Those tags would go in both the file level and class level docblocks. The one thing I REALLY care about in this proposal is the substitution process. It should be done automatically by the installer. It would be great if we don't have to use the package file manager or maintain package.xml with a replace element for each file. Everyone, any strong objections? Thanks, --Dan -- T H E A N A L Y S I S A N D S O L U T I O N S C O M P A N Y data intensive web and database programming http://www.AnalysisAndSolutions.com/ 4015 7th Ave #4, Brooklyn NY 11232 v: 718-854-0335 f: 718-854-0409