Re: Re: coding standards: Header Comment Blocks
| From: | Daniel Convissor | Date: | Tue, 08 Jun 2004 05:18:00 +0000 |
| Subject: | Re: Re: coding standards: Header Comment Blocks | ||
| References: | 1 2 3 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-30125@lists.php.net to get a copy of this message | ||
Hi Paul:
On Mon, Jun 07, 2004 at 06:22:53PM -0500, Paul M Jones wrote:
>
> >> * @license http://www.php.net/license/3_0.txt PHP
> >> License
> >> * @version $Id:$
>
> Version might not be the same as the CVS revision.
This is a file level docblock. It should reflect the version of the file,
not the package. Along the same lines, JavaDoc guidelines say the
@version tag for classes should also be the CVS revision number.
--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