coding standards: Header Comment Blocks
| From: | Daniel Convissor | Date: | Mon, 07 Jun 2004 21:59:04 +0000 |
| Subject: | coding standards: Header Comment Blocks | ||
| Groups: | php.pear.dev | ||
| Request: | Send a blank email to pear-dev+get-30105@lists.php.net to get a copy of this message | ||
Hello:
Klaus raised an interseting point on IRC regarding Header Comment Blocks.
For phpDocumentor to work correctly, we really need to have a page-level
docblocks.
The current standard requires a regular comment at the top of each file:
http://pear.php.net/manual/en/standards.header.php
Can we please modify the standard to make the header comments to be in
docblock format? I'd suggest the following for a standard file:
/**
* Short description for file
*
* Long description...
*
* PHP version 4 or 5
*
* This source file is subject to version 3.0 of the PHP license,
* that is bundled with this package in the file LICENSE, and is
* available through the world-wide-web at the following URI:
* http://www.php.net/license/3_0.txt.
* If you did not receive a copy of the PHP license and are unable to
* obtain it through the world-wide-web, please send a note to
* license@php.net so we can mail you a copy immediately.
*
* @category categoryname
* @package packagename
* @author Original Author <author@example.com>
* @author Another Author <another@example.com>
* @copyright Copyright (c) 1997-2004 The PHP Group
* @license http://www.php.net/license/3_0.txt
PHP License
* @version $Id:$
*/
What are your thoughts?
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