Re: Re: coding standards: Header Comment Blocks

Daniel Convissor wrote:

Hi Folks: On Tue, Jun 08, 2004 at 10:32:53AM +0200, Tobias Schlitt wrote:

Hi Tomas V.V.Cox! You wrote:

You can use the PEAR package replace capabilities. Ex:

* @version @package_version@ (CVS rev: $Id:$)

and in package.xml

<file name="Class.php"> <replace from="@package_version@" to="version" type="package-info"/> </file>

So, we'd have to put the replacement tags in each file and put in replace elements for each file in the package.xml file. A headache and another vector for potential errors. The JavaDoc standard is to use CVS $Id$ keyword. It's simple to implement.

I really dislike reading $Id$, $Revision$ is better for the @version tag. $Id$ can be required for the description. I really think we will regret not suggesting the package version be in the file @version tag as well. Greg