Maison  >  Article  >  développement back-end  >  Comment annoter les spécifications de classe en php

Comment annoter les spécifications de classe en php

怪我咯
怪我咯original
2017-06-16 16:00:121796parcourir

@access
Périmètre d'utilisation : classe, fonction, var, définition, module
Cette balise est utilisée pour indiquer l'autorisation d'accès aux mots-clés : privé, public ou protégé
@auteur
Indiquez le auteur
@copyright
Portée d'utilisation : classe, fonction, var, définir, module, utilisation
Indiquer les informations de copyright
@obsolète
Portée d'utilisation : classe, fonction, var, définir, module, constent , global, include
Indique des mots-clés inutilisés ou obsolètes
@example
Cette balise est utilisée pour analyser un élément du contenu d'un fichier et le mettre en évidence. Phpdoc essaiera de lire le contenu du fichier à partir du chemin du fichier donné par cette balise 🎜>Portée d'utilisation : classe, fonction, var
Indique que le mot-clé est une classe finale, une méthode, un attribut et interdit dérivation et modification.
@filesource
Similaire à l'exemple, sauf que cette balise lira directement le contenu du fichier php actuellement analysé et l'affichera.
@global
Indique la variable globale référencée dans cette fonction
@ingore
permet d'ignorer le mot-clé spécifié dans le document
@license
est équivalent au
html Le dans
est l'URL en premier, suivi du contenu à afficher
Par exemple,
BaiduPeut être écrit comme @license http://www.baidu.com Baidu
@link
Similaire à licence mais vous pouvez également pointer vers n'importe quel mot-clé dans le document via un lien
@name
Spécifiez un alias pour le mot-clé.
@package
Portée d'utilisation : niveau page -> définir, fonction, inclure
Niveau classe ->class, var, méthodes
est utilisé pour combiner logiquement un ou plusieurs mots-clés attribués à un groupe .
@abstrcut
Indique que la classe actuelle est une
classe abstraite

@param
Spécifie un paramètre d'une
fonction @return
Spécifie un Le pointeur de retour d'une méthode ou d'une fonction est
@static
indiquant que le mot-clé est statique.
@var
Indiquez le type de variable@version Indiquez les informations de version
@todo
Indiquez les domaines qui devraient être améliorés ou non implémentés
@throws
Indiquez que cette fonction peut générer des exceptions d'erreur, extrêmement rares
Comme mentionné ci-dessus, les balises de document ordinaires doivent être marquées d'un @ au début de chaque ligne. De plus, il existe également une balise appelée balise en ligne, utilisant les expressions {@}. les types suivants :
{@link}
L'utilisation est la même que @link
{@source}
Afficher le contenu d'une fonction ou d'une méthode

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!

Déclaration:
Le contenu de cet article est volontairement contribué par les internautes et les droits d'auteur appartiennent à l'auteur original. Ce site n'assume aucune responsabilité légale correspondante. Si vous trouvez un contenu suspecté de plagiat ou de contrefaçon, veuillez contacter admin@php.cn
Article précédent:séparateur de commandes phpArticle suivant:séparateur de commandes php