Utilizarea docblock comentarii în PHP

sintaxa phpdoc

Poate că este de remarcat faptul că fiecare linie într-un bloc trebuie să înceapă cu un *. Nume descriptori precedate de semnul @.

phpdoc poate descrie nu numai secțiunile individuale ale codului, dar fișierul script-ul întreg, stabilindu-se în jos la începutul fișierului. Un astfel de bloc este numit un antet.

Descriptorii @access. @final și @abstract au fost relevante în PHP 4, dar acum ele nu pot fi folosite pentru că au pierdut relevanța odată cu apariția modificatorilor de acces și cuvintele cheie finale și abstracte.

Fiecare docBLock este împărțită în mai multe secțiuni:

Separarea secțiune pentru șirul nul.

Am scurtat foarte mult descrierea detaliată a metodelor și a claselor, evitând redundanța în termen de exemplu. Să acorde o atenție la principiul general al documentării și sintaxa descriptor.

Utilizarea tag-ul @see

Și aici este un exemplu de sfaturi (cod Eclipse de asistare), care pot oferi un mediu de dezvoltare, în acest caz, Eclipse.

De asemenea, mediul de dezvoltare poate indicii de ieșire bazate pe docBlock. De exemplu, mesajul care apare atunci când treceți peste Zend_Acl_Role_Registry :: add () numele metodei.

Există o clasă cu mijloace publice și protejate auxiliare, care este utilizat în principal de impurități de clasă trăsătură. Cum de a importa în clasa principală a întregii clasei trasatura auto care este în vidilis ca metodele publice și în cadrul clasei, IDE nu a jurat pe metodele private?