PHP Function Commentaires

Question

Juste une petite question: j'ai vu que certaines fonctions PHP sont commentées en haut, en utilisant un format qui m'est inconnu:

 /**
 *
 * Convert an object to an array
 *
 * @param    object  $object The object to convert
 * @return      array
 *
 */
 

Mon IDE me donne une sélection déroulante pour des choses telles que @param et @return, elle doit donc être documentée quelque part. J'ai essayé de chercher sur Google, mais le symbole @ n'est pas inclus dans la recherche.

Quel est ce format de commentaire et où puis-je trouver des informations?

Answer 1

Les fonctions:

 /**
 * Does something interesting
 *
 * @param  Place    $where  Where something interesting takes place
 * @param  integer  $repeat How many times something interesting should happen
 * @throws Some_Exception_Class If something interesting cannot happen
 * @return Status
 */ 
 

Des classes:

 /**
 * Short description for class
 *
 * Long description for class (if any)...
 *
 * @copyright  2006 Zend Technologies
 * @license    http://www.zend.com/license/3_0.txt   PHP License 3.0
 * @version    Release: @package_version@
 * @link       http://dev.zend.com/package/PackageName
 * @since      Class available since Release 1.2.0
 */ 
 

Answer 2

C'est la syntaxe phpDoc.

Lisez plus ici: phpDocumentor

Answer 3

Vous pouvez obtenir les commentaires d'une méthode particulière en utilisant la classe ReflectionMethod et en appelant -> getDocComment ().

http://www.php.net/manual/en/reflectionclass.getdoccomment.php