Question

I am confused about how to properly use the @package and @subpackage tags when documenting my PHP code. If it’s of any relevance, this is for CakePHP 2.x

How would I write the package tags for the classes located in the following directories within my application, for example:

app/Model/User.php

app/Model/Behavior/Sortable.php

app/Model/Behavior/Custom/Validator.php

...

And so on, with further subdirectories. I am particularly unsure about classes that reside in deep subdirectories.

/**
 * @package ??
 * @subpackage ??
 */
class ValidatorBehavior extends ModelBehavior {

}

Answer 1

Well it’s matter of agreement and convention. Cake uses like:

/*
 * @package App
 * @subpackage App.Model.Behavior
 * /

...