2016-07-29 1 views
0

Est-il possible de déclarer protected ou private class @proptery à l'aide de PhpDoc?PhpDoc: propriété protégée

/** 
* Class Node 
* @package app\models 
* @property string $name 
*/ 
class Node 
{ 

} 
+1

Je peux me tromper, mais pourquoi dire que cette classe a des propriétés qui ne sont pas accessibles? – Justinas

Répondre

3

Je ne pense pas. Pour @property, public est implicite, même s'il est en lecture seule ou en écriture seule. Le but de ces étiquettes est de documenter des interfaces qui ne peuvent être déduites. Une variable privée/protégée est réellement interne à la classe, donc elle ne concerne que les classes enfants qui doivent être écrites comme si elles le savaient déjà. Vous pouvez toujours laisser un docblock simple immédiatement avant de le déclarer, cependant.

+0

S'il existe une raison de mettre en évidence une propriété magique qui n'est pas réellement publique, vous pouvez utiliser la balise '@ internal' pour expliquer pourquoi cette propriété mérite d'être mise en évidence. – ashnazg