[PEPr] Comment on PHP::PHP_GenDocBlock
| From: | Christian Weiske | Date: | Tue, 15 May 2007 08:02:40 +0000 |
| Subject: | [PEPr] Comment on PHP::PHP_GenDocBlock | ||
| References: | 1 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-46765@lists.php.net to get a copy of this message | ||
Christian Weiske (http://pear.php.net/user/cweiske) has commented on the proposal for
PHP::PHP_GenDocBlock.
Comment:
class PHP_GenDocBlock:
- newline between class definition and { (in all files)
- you are hiding errors when using file_get_contents - maybe you should
have a better error handling mechanism
PHP_GenDocBlockTest:
- comment for run() method have strange indentation
same for PHP_GenDocBlock_Cli
PHP_GenDocBlock_Cli:
- You should either use Console_GetArgs or Console_GetOpts for parameter
handling, not do everything yourself
PHP_GenDocBlock_Tokens:
- Strange indentation in comment for "public $eol;"
- process is unreadable, please insert a line feed after each break;
PHP_GenDocBlock_Type:
- Please try to stick to the 80 chars-a-line soft limit, e.g. when having
comments after code (i.e. in extract()) - you should move the comment above
the code
from:
if (($key = array_search('', $types)) !== false)
unset($types[$key]); // removes the empty type/string
to:
// removes the empty type/string
if (($key = array_search('', $types)) !== false)
unset($types[$key]);
- Why do you have "// /" in your array definitions?
private $license = array(// /
- Rethink if you need all variables private, or may make some of them
protected to allow subclassing
- It is not docblock related, but maybe you want to add the cmdline switch
to add the vim indentation settings to each file's bottom.
Proposal information:
http://pear.php.net/pepr/pepr-proposal-show.php?id=481
--
Sent by PEPr, the automatic proposal system at http://pear.php.net