-- onur.ozgur.ozkan <[email protected]> wrote
(on Wednesday, 06 July 2011, 03:53 AM -0700):
> My question is over how to use phpDocs on ZF. What do you write @category,
> @package and @subpackage at Controller, Model for classes? We write like
> above at Company. Do you think it is correct?
>
> Best Regards.
>
> /**
> * Blog_IndexController
> *
> * @category ApplicationName
> * @package Blog Module
> * @subpackage Blog_IndexController
These annotations have fairly strict requirements, IIRC:
/[a-zA-Z][a-zA-Z0-9_]*/
in other words, a mix of alphanumeric characters and underscores ONLY
(no spaces).
Additionally, think of package and subpackage as defining a hierarchy
within your system -- a way to group related classes. In this case, I'd
do the following:
@category ApplicationName
@package Blog
@subpackage Controllers
and have all my controllers in that directory share the same
annotations. That way, when I generate my docs, they're grouped.
> */
> class Blog_IndexController extends Zend_Controller_Action
> {}
--
Matthew Weier O'Phinney
Project Lead | [email protected]
Zend Framework | http://framework.zend.com/
PGP key: http://framework.zend.com/zf-matthew-pgp-key.asc
--
List: [email protected]
Info: http://framework.zend.com/archives
Unsubscribe: [email protected]
