Looking for php Keywords? Try Ask4Keywords

PHPPHPDoc


Syntaxe

  • @api
  • @author [nom] [<adresse email>]
  • @copyright <description>
  • @ obsolète [<"Version sémantique">] [: <"Version sémantique">] [<description>]
  • @exemple [URI] [<description>]
  • {@exemple [URI] [: <début> .. <fin>]}
  • @inheritDoc
  • @interne
  • {@internal [description]}}
  • @license [<identifiant SPDX> | URI] [nom]
  • @method [return "Type"] [name] (["Type"] [paramètre], [...]) [description]
  • @package [niveau 1] \ [niveau 2] \ [etc.]
  • @param ["Type"] [nom] [<description>]
  • @property ["Type"] [nom] [<description>]
  • @return <"Type"> [description]
  • @see [URI | "FQSEN"] [<description>]
  • @since [<"Version sémantique">] [<description>]
  • @throws ["Type"] [<description>]
  • @todo [description]
  • @usus [fichier | "FQSEN"] [<description>]
  • @var ["Type"] [nom_élément] [<description>]
  • @version ["Version sémantique"] [<description>]
  • @filesource - Inclut le fichier en cours dans les résultats d'analyse phpDocumentor
  • @link [URI] [<description>] - La balise de lien aide à définir la relation ou le lien entre les éléments structurels .

Remarques

"PHPDoc" est une section de la documentation qui fournit des informations sur les aspects d'un "élément structurel" - PSR-5

Les annotations PHPDoc sont des commentaires qui fournissent des métadonnées sur tous les types de structures en PHP. De nombreux IDE populaires sont configurés par défaut pour utiliser les annotations PHPDoc afin de fournir des informations sur le code et d'identifier les problèmes éventuels avant qu'ils ne surviennent.

Bien que les annotations PHPDoc ne fassent pas partie du noyau PHP, elles contiennent actuellement le statut brouillon avec PHP-FIG en tant que PSR-5 .

Toutes les annotations PHPDoc sont contenues dans DocBlocks et sont illustrées par une ligne multiple avec deux astérisques:

/**
 *
 */

Le brouillon de normes PHP-FIG est disponible sur GitHub .

PHPDoc Exemples Liés