>  기사  >  백엔드 개발  >  PHP의 표준 주석 방법은 무엇입니까?

PHP의 표준 주석 방법은 무엇입니까?

little bottle
little bottle원래의
2019-04-17 17:57:374189검색


이 글에서는 6가지 PHP 주석 방법을 함께 배워보겠습니다!

PHP 한 줄 주석 구문

모든 DE>//DE>의 오른쪽에 있는 텍스트 ; PHP 파서가 해당 라인을 무시하기 때문에 한 라인의 기호는 주석으로 처리됩니다. DE>//DE> 모든 것이 오른쪽에 있습니다. 다음과 같습니다:

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

다음과 같이 코드 없이 한 줄로만 주석을 작성할 수도 있습니다.

<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>

Block commentsBlock 댓글은 일반적으로 문서, 메서드, 데이터 구조 및 알고리즘 설명. 블록 주석은 모든 파일의 시작 부분과 모든 메서드 앞에 배치됩니다. 내부 메서드 등 다른 곳에서도 사용할 수 있습니다. 함수와 메소드 내부의 블록 주석은 설명하는 코드와 동일한 들여쓰기를 가져야 합니다.

블록 주석을 코드에서 분리하려면 블록 주석 시작 부분에 빈 줄이 있어야 합니다. 예:

# 🎜🎜 블록 주석은 시작 부분에 /*-를 사용할 수 있으므로 indent(1)는 이를 재정렬하지 않고도 코드 블록의 시작으로 인식할 수 있습니다.

/*
 
* 这里是块注释
*/

# #참고 : indent(1)을 사용하지 않으면 코드에서 /*-를 사용할 필요가 없습니다. 그렇지 않으면 다른 사람이 코드에서 indent(1)를 실행할 가능성을 감수해야 합니다. 한 줄 주석
짧은 주석은 한 줄에 표시될 수 있으며 그 뒤에 있는 코드와 동일한 들여쓰기 수준을 갖습니다. 한 줄에 주석을 작성할 수 없는 경우에는 블록 주석을 사용하십시오. 한 줄 주석 앞에는 빈 줄이 와야 합니다. 다음은 코드에 있는 한 줄 주석의 예입니다.

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


End Note# 🎜🎜#

매우 짧음 주석은 설명하는 코드와 같은 줄에 있을 수 있지만 코드와 주석을 구분할 수 있는 충분한 공백이 있어야 합니다. 여러 개의 짧은 주석이 큰 코드 블록에 나타나는 경우 들여쓰기가 동일해야 합니다. 다음은 코드의 꼬리 주석의 예입니다.



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 중국어 웹사이트의 기타 관련 기사를 참조하세요!

성명:
본 글의 내용은 네티즌들의 자발적인 기여로 작성되었으며, 저작권은 원저작자에게 있습니다. 본 사이트는 이에 상응하는 법적 책임을 지지 않습니다. 표절이나 침해가 의심되는 콘텐츠를 발견한 경우 admin@php.cn으로 문의하세요.