PHP の標準的なアノテーション方法は何ですか?

#この記事では 6 つの PHP アノテーション方法を紹介します。一緒に学びましょう。

PHP の単一行コメント構文

行内の DE>//DE> 記号の右側にあるすべてのテキストは、コメントとみなされます。コメント。PHP パーサーはこの行を無視するため DE>//DE> すべて右側。次のように:

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

次のように、コメントのみを 1 行に記述し、コードを書かずに次のように記述することもできます:

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

PHP複数行のコメント構文

PHP の複数行のコメントは DE>/*DE> で始まり、で終わります。 DE>*/DE>終了。 DE>/*DE> と DE>*/DE> の間には、複数行のコメントを記述できます。

例は次のとおりです。赤い部分が複数行のコメントの内容です。

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

ブロック コメント
ブロック コメントは通常、ファイル、メソッド、データ構造、アルゴリズムの説明を提供するために使用されます。ブロック コメントは、すべてのファイルの先頭とすべてのメソッドの前に配置されます。これらはメソッド内など、他の場所でも使用できます。関数やメソッド内のブロック コメントには、記述されているコードと同じインデントが必要です。

ブロック コメントとコードを区切るために、ブロック コメントの先頭に空行を入れる必要があります。例:

##

/*
 
* 这里是块注释
*/

ブロックのコメントは /*- で始めることができるため、indent(1) はそれをコードとして認識できます。順序を変更せずにブロックの先頭に移動します。


##

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

注: を使用しない場合は、 indent(1) を使用する場合、コード内で /*- を使用する必要はありません。また、他の人がコード上で indent(1) を実行する可能性を考慮する必要もありません。 単一行コメント短いコメントは 1 行に記述でき、次のコードと同じインデント レベルを持ちます。コメントを 1 行で記述できない場合は、ブロックコメントを使用してください。単一行のコメントの前には空行を入れる必要があります。コード内の 1 行のコメントの例を次に示します。

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

末尾のコメント

非常に短いコメントは、説明するコードと同じ行に記述できますが、十分な空白で区切る必要があります。コードとコメント。複数の短いコメントがコードの大きなブロック内に出現する場合、同じインデントを持つ必要があります。 以下は、コード内の末尾のコメントの例です:

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视频教程】

以上がPHP の標準的なアノテーション方法は何ですか?の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。