Looking for php Keywords? Try Ask4Keywords

PHPPHPDoc


Syntax

  • @api
  • @author [Name] [<E-Mail-Adresse>]
  • @copyright <Beschreibung>
  • @deprecated [<"Semantic Version">] [: <"Semantic Version">] [<description>]
  • @example [URI] [<description>]
  • {@example [URI] [: <start> .. <end>]}
  • @inheritDoc
  • @internal
  • {@interne [Beschreibung]}}
  • @license [<SPDX-Kennung> | URI] [Name]
  • @method [return "Type"] [Name] (["Type"] [Parameter], [...]) [Beschreibung]
  • @Paket [Ebene 1] \ [Ebene 2] \ [etc.]
  • @param ["Typ"] [Name] [<Beschreibung>]
  • @ property ["Type"] [name] [<description>]
  • @return <"Type"> [Beschreibung]
  • @see [URI | "FQSEN"] [<description>]
  • @since [<"Semantic Version">] [<description>]
  • @throws ["Typ"] [<description>]
  • @Todo [Beschreibung]
  • @uses [Datei | "FQSEN"] [<description>]
  • @var ["Typ"] [Elementname] [<Beschreibung>]
  • @version ["Semantic Version"] [<description>]
  • @filesource - Schließt die aktuelle Datei in die Analyseergebnisse von phpDocumentor ein
  • @link [URI] [<description>] - Das Link-Tag hilft beim Definieren der Beziehung oder Verknüpfung zwischen Strukturelementen .

Bemerkungen

"PHPDoc" ist ein Abschnitt der Dokumentation, der Informationen zu Aspekten eines "Strukturelements" - PSR-5 enthält

PHPDoc-Annotationen sind Kommentare, die Metadaten zu allen Arten von Strukturen in PHP bereitstellen. Viele gängige IDEs sind standardmäßig so konfiguriert, dass PHPDoc-Anmerkungen verwendet werden, um Codeeinsichten bereitzustellen und mögliche Probleme zu erkennen, bevor sie auftreten.

PHPDoc-Anmerkungen sind zwar nicht Teil des PHP-Kerns, jedoch halten sie derzeit den Entwurfsstatus mit PHP-FIG als PSR-5 .

Alle PHPDoc-Anmerkungen sind in DocBlocks enthalten , die durch eine mehrzeilige Zeile mit zwei Sternen dargestellt werden:

/**
 *
 */

Der vollständige Entwurf der PHP-FIG- Standards ist auf GitHub verfügbar .

PHPDoc Verwandte Beispiele