Quelles sont les méthodes d’annotation standards en PHP ?

Cet article présente six méthodes de commentaires PHP. Apprenons-les ensemble !

Syntaxe de commentaire PHP sur une seule ligne

Tout le texte à droite du symbole DE>//DE> commentaire,Parce quePHP L'analyseur ignore cette ligne DE>//DE> Tout à droite. Comme suit :

<span style="font-family: 微软雅黑, "Microsoft YaHei"; font-size: 14px;"><?php<br/>echo "Blabla.cn"; // 这是单行注释?><br/></span>

Vous pouvez également l'écrire comme ceci, n'écrire des commentaires que sur une seule ligne, sans code, comme suit :

<span style="font-family: 微软雅黑, "Microsoft YaHei"; font-size: 14px;"><?php// 这是单行注释echo "Blabla.cn"; <br/>// 这是单行注释?><br/></span>

Syntaxe des commentaires multilignes PHP

Le commentaire multiligne PHP commence par DE>/*DE> DE>*/DE> Entre DE>/*DE> et DE>*/DE>, vous pouvez écrire plusieurs lignes de commentaires.

L'exemple est le suivant, la partie rouge est le contenu des commentaires multilignes.

<span style="font-family: 微软雅黑, "Microsoft YaHei"; font-size: 14px;"><?php<br/>echo "Blabla.cn";/*<br/>这是多行注释<br/>这是多行注释<br/>*/?><br/></span>

Commentaires en bloc

Les commentaires en bloc sont généralement utilisés pour fournir des descriptions de fichiers, de méthodes, de structures de données et d'algorithmes. Les commentaires de bloc sont placés au début de chaque fichier et avant chaque méthode. Ils peuvent également être utilisés ailleurs, comme dans les méthodes internes. Les commentaires de bloc à l’intérieur des fonctions et des méthodes doivent avoir la même indentation que le code qu’ils décrivent.

Il doit y avoir une ligne vide au début du commentaire de bloc pour séparer le commentaire de bloc du code, par exemple :

/*
 
* 这里是块注释
*/

Les commentaires de bloc peuvent commencer par /*-, afin que indent(1) puisse le reconnaître comme Le début d'un bloc de code sans le redistribuer.

/*-
 
* 如果想被忽略，可是使用特别格式的块注释
*
* one
* 　　two
* 　　　　three
*/

REMARQUE : Si vous ne En utilisant indent(1), vous n'êtes pas obligé d'utiliser /*- dans votre code ou de céder à la possibilité que quelqu'un d'autre exécute indent(1) sur votre code.
Commentaires sur une seule ligne

Les commentaires courts peuvent être affichés sur une seule ligne et avoir le même niveau d'indentation que le code suivant. Si un commentaire ne peut pas être écrit sur une seule ligne, utilisez un commentaire en bloc. Les commentaires sur une seule ligne doivent être précédés d’une ligne vide. Voici un exemple de commentaire sur une seule ligne dans le code :

if (condition) {
 
/* 以下代码运行的条件 */
 
...
}

Commentaires de queue

Des commentaires très courts peuvent être sur la même ligne que le code qu'ils décrivent, mais il devrait y en avoir suffisamment espace blanc pour séparer le code et les commentaires. Si plusieurs commentaires courts apparaissent dans un gros bloc de code, ils doivent avoir la même indentation.
Ce qui suit est un exemple de commentaire de fin dans le code :

if ($a == 2) {
 
return TRUE; /* 对单一条件的说明 */
} else {
return isPrime($a); /* 其余的条件 */
}

行末注释

注释界定符"//"，可以注释掉整行或者一行中的一部分。它一般不用于连续多行的注释文本；然而，它可以用来注释掉连续多行的代码段。以下是所有三种风格的例子：

if ($foo > 1) {
 
// 第二种用法.
 
...
}
else {
return false; // 说明返回值的原因
}
//if ($bar > 1) {
 
//
// 　// 第三种用法
//　 ...
//}
//else {
// return false;
//}

文档注释

文档注释描述php的类、构造器，方法，以及字段(field)。每个文档注释都会被置于注释定界符/**...*/之中，一个注释对应一个类或成员。该注释应位于声明之前：

/**
 
* 说明这个类的一些 ...
*/
class Example { ...

注意

顶层(top-level)的类是不缩进的，而其成员是缩进的。

描述类的文档注释的第一行(/**)不需缩进；随后的文档注释每行都缩进1格(使星号纵向对齐)。

成员，包括构造函数在内，其文档注释的第一行缩进4格，随后每行都缩进5格。

文档注释不能放在一个方法或构造器的定义块中，因为程序会将位于文档注释之后的第一个声明与其相关联。

【相关课程：PHP视频教程】

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!