PHPPHPDoc


Sintassi

  • @api
  • @author [nome] [<indirizzo email>]
  • @copyright <description>
  • @deprecated [<"Versione semantica">] [: <"Versione semantica">] [<descrizione>]
  • @esempio [URI] [<descrizione>]
  • {@esempio [URI] [: <start> .. <end>]}
  • @inheritDoc
  • @interno
  • {@internal [description]}}
  • @license [<identificatore SPDX> | URI] [nome]
  • @method [return "Type"] [name] (["Type"] [parametro], [...]) [descrizione]
  • @package [livello 1] \ [livello 2] \ [ecc.]
  • @param ["Tipo"] [nome] [<descrizione>]
  • @property ["Tipo"] [nome] [<descrizione>]
  • @return <"Tipo"> [descrizione]
  • @vedi [URI | "FQSEN"] [<descrizione>]
  • @since [<"Versione semantica">] [<descrizione>]
  • @throws ["Tipo"] [<descrizione>]
  • @todo [descrizione]
  • @uses [file | "FQSEN"] [<descrizione>]
  • @var ["Tipo"] [nome_elemento] [<descrizione>]
  • @version ["Versione semantica"] [<descrizione>]
  • @filesource: include il file corrente nei risultati di analisi phpDocumentor
  • @link [URI] [<description>] - Il tag link aiuta a definire la relazione o il collegamento tra elementi strutturali .

Osservazioni

"PHPDoc" è una sezione di documentazione che fornisce informazioni sugli aspetti di un "elemento strutturale" - PSR-5

Le annotazioni PHPDoc sono commenti che forniscono metadati su tutti i tipi di strutture in PHP. Molti IDE popolari sono configurati per impostazione predefinita per utilizzare le annotazioni PHPDoc per fornire informazioni sul codice e identificare possibili problemi prima che si verifichino.

Mentre le annotazioni PHPDoc non fanno parte del core PHP, attualmente mantengono lo stato di bozza con PHP-FIG come PSR-5 .

Tutte le annotazioni PHPDoc sono contenute in DocBlocks dimostrate da una linea multipla con due asterischi:

/**
 *
 */

La versione completa degli standard PHP-FIG è disponibile su GitHub .

PHPDoc Esempi correlati