Re: Re: coding standards: Header Comment Blocks

On Tue, 8 Jun 2004 at 10:29:59, 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> > > > '@pacakge_version@' will be replaced with the version extracted from you > > package.xml release file. Maybe to include the 'state' could be usefull > too. > > +10 on this solution. This should become general standard for all packages > and files. Seems fine for me as well and makes sense if people have a look in the source instead of using the installer to find out about the installed version. However, I wonder if it might make more sense to replace the tag while packaging? After you build the package the number should not change - so if people look inside the archive they could easily see the version prior to installing it (and prior to looking in the package.xml). > We can beside that add similar replacement behavior for the @package tag. > This would make the phpDocumentor generation much more comfortable. Didn't get you here ... > This should be worth an RFC. Does anyone volunteer to provide it? I won't because for the actual limited time, sorry! However, imho we could also put a few other things into that proposal - e.g. the usage of dirname(__FILE__) when including a file in a class, as discussed in a separate thread with Greg shortly ago. Greg and me are in favor or such a solution since it ensures loading e.g. the correct drivers no matter what's in the include-path. Stefan