Balises de commentaires que tout PHPer devrait maîtriser !

                                                     

Recommandé : "Tutoriel vidéo PHP"

Avant-propos

La balise de commentaire joue un rôle très important dans commentaires de code De grandes balises d'annotation de bonne qualité peuvent vous offrir une expérience meilleure et plus confortable dans le processus de programmation, je vais donc aujourd'hui trier ces balises et les afficher sous forme d'images et de textes. m'aider à comprendre ces balises d'annotation. Un résumé D'un autre côté, j'espère aussi que tout le monde pourra mieux comprendre les balises de commentaire

Tout le monde espère écrire du beau code. Peut-être que vous n'êtes qu'à une balise. beau code

Balises communes

tr> tr> @var

Tag

Objectif

Description

@abstract

标记	用途	描述
@abstract		抽象类的变量和方法
@access	public, private or protected	文档的访问、使用权限. @access private 表明这个文档是被保护的。
@author	张三 zhangsan@163.com	文档作者
@copyright	名称 时间	文档版权信息
@deprecated	version	文档中被废除的方法
@deprec		同 @deprecated
@example	/path/to/example	文档的外部保存的示例文件的位置。
@exception		文档中方法抛出的异常，也可参照 @throws.
@global	类型：$globalvarname	文档中的全局变量及有关的方法和函数
@ignore		忽略文档中指定的关键字
@internal		开发团队内部信息
@link	URL	类似于license 但还可以通过link找到文档中的更多个详细的信息
@name	变量别名	为某个变量指定别名
@magic		phpdoc.de compatibility
@package	封装包的名称	一组相关类、函数封装的包名称
@param	如 $username 用户名	变量含义注释
@return	如 返回bool	函数返回结果描述，一般不用在void（空返回结果的）的函数中
@see	如 Class Login()	文件关联的任何元素（全局变量，包括，页面，类，函数，定义，方法，变量）。
@since	version	记录什么时候对文档的哪些部分进行了更改
@static		记录静态类、方法
@staticvar		在类、函数中使用的静态变量
@subpackage		子版本
@throws		某一方法抛出的异常
@todo		表示文件未完成或者要完善的地方
@var	type	文档中的变量及其类型
@version		文档、类、函数的版本信息

Variables et méthodes des classes abstraites

@access

public, privé ou protégé

Accès au document et droits d'utilisation @access private indique que ce document est protégé.

@auteur

Zhang San zhangsan@163.com

Auteur du document

@copyright

Heure du nom

Informations sur les droits d'auteur du document

@obsolète

version td>

Méthodes obsolètes dans la documentation

@deprec

Identique à @deprecated

@example

/path/to/example

L'emplacement du fichier d'exemple enregistré en externe dans le document.

@exception

Pour les exceptions levées par les méthodes dans le document, vous pouvez également vous référer à @throws.

@global

Type : $globalvarname

Variables globales et méthodes et fonctions associées dans le document

@ignore

Ignorer les mots-clés spécifiés dans le document

@internal td>

Informations internes de l'équipe de développement

@link

URL

Similaire à la licence mais vous pouvez également trouver des informations plus détaillées dans le document via le lien

@name

Alias ​​variable

Spécifiez un alias pour une variable

@magic

Compatibilité phpdoc.de

@package

Le nom du package encapsulé

Le nom du package empaqueté par un groupe de classes et de fonctions associées

@param

Par exemple $username nom d'utilisateur

Commentaire de signification variable

@ return

If return bool

La fonction renvoie une description du résultat, qui n'est généralement pas utilisée dans les fonctions void (résultat de retour vide)

@see

Par exemple Class Login()

Tout élément associé au fichier (variables globales, y compris les pages, classes, fonctions, définitions, méthodes, variables).

@since

version

Enregistrer quand des modifications ont été apportées à quelles parties du document

@static

Enregistrer les classes et méthodes statiques

@staticvar

Variables statiques utilisées dans les classes et fonctions

@subpackage

td>

Sous-version

@throws

Exception levée par une certaine méthode

@todo

Indique que le fichier est incomplet ou doit être amélioré

type

Variables et leurs types dans le document

@version

Informations de version des documents, classes et fonctions

Beaucoup des éléments ci-dessus doivent en fait être ajoutés lors de la création de fichiers et de classes. Aujourd'hui, je vais principalement expliquer les balises couramment utilisées.

@param

Description

Paramètre, utilisé pour les balises dans les commentaires de fonction et de méthode
Format@param [Type] [name] [<description>]</description>
Par exemple@param string title 文章标题

Exemple de code

@return

Description

Valeur de retour
Format @return [Type] [Par exemple @return array result array

Exemple de code

@obsolète

Explication

Obsolète, expiré et sera supprimé
formats @deprecated [] []
tels que @deprecated 1.0.0 新版本将不再包含此函数
S'il est remplacé par d'autres méthodes, il est recommandé d'ajouter la balise @see

Exemple de code

@see

Explication

La référence, similaire à @link, peut être liée avec @deprecated
Format@ voir [url ou nom complet de la méthode] []
Par exemple @see yiibasedb::tableName() L'ancienne méthode table_name est obsolète, veuillez utiliser cette méthode à la place

Exemple de code

Lien

@link

Description

, qui peut être utilisé pour des explications auxiliaires, des documents de référence, etc.
Format@link [url] []
Par exemple@link http://g.cn 不懂滚去问谷歌，别来烦我

Exemple de code

@link&@voir la différence

-	@see	@link
外部链接	√	√
内部程序	√	X

@var

Explication

Variable
Format@var [类型] [变量名] []
Par exemple@var int id 用户id

Liste de variables

变量类型	说明
string	字符串
integer/int	number/int类型
boolean/bool	false/true
float/double	number/浮点数
object	对象实例
specifiedType	指定类
mixed	任意类型
array/specifiedType[]	数组，可以指定成指定类型的数组
resource	文件资源类型
void	无返回值
null	-
callable	可执行的回调函数
function	不一定能执行的方法
self/$this	当前实例

Exemple de code

1. Variables en dehors de la méthode Définition

2. Définition des variables au sein de la méthode

@throws

Explication

peut être le type d'erreur générée
Format@throws [类型] []
Par exemple@throws Exception

                                                    🎜>

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!