欢迎光临杨雨的个人博客站!

杨雨个人网站-杨雨个人博客-杨照佳

杨雨个人博客网站

关注互联网和搜索引擎的个人博客网站

首页 > WEB开发 > PHP >

PHP规范的注释方法有哪些?

发布时间:2019-05-24  编辑:杨雨个人博客网站   点击:   


本篇文章介绍了六种PHP的注释方式,大家一起来学习一下吧!

PHP 单行注释语法

在一行中所有 DE>//DE> 符号右面的文本都被视为注释, 因为 PHP 解析器忽略该行 DE>//DE> 右面的所有内容。如下:

<?php
echo "Blabla.cn"; // 这是单行注释?>

你也这样这样写,一行只写注释,不写代码,如下:

<?php// 这是单行注释echo "Blabla.cn"; 
// 这是单行注释?>

PHP 多行注释语法

PHP 多行注释以 DE>/*DE> 开头,以 DE>*/DE> 结束。在 DE>/*DE> 和 DE>*/DE> 之间,可以写多行注释。

示例如下,红色部分就是多行注释的内容。

<?php
echo "Blabla.cn";/*
这是多行注释
这是多行注释
*/?>

块注释

块注释通常用于提供对文件,方法,数据结构和算法的描述。块注释被置于每个文件的开始处以及每个方法之前。它们也可以被用于其他地方,比如方法内部。在功能和方法内部的块注释应该和它们所描述的代码具有一样的缩进格式。

块注释之首应该有一个空行,用于把块注释和代码分割开来,比如:

/*
 
* 这里是块注释
*/


块注释可以以/*-开头,这样indent(1)就可以将之识别为一个代码块的开始,而不会重排它。


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

注意:如果你不使用indent(1),就不必在代码中使用/*-,或为他人可能对你的代码运行indent(1)作让步。
单行注释

短注释可以显示在一行内,并与其后的代码具有一样的缩进层级。如果一个注释不能在一行内写完,就该采用块注释。单行注释之前应该有一个空行。以下是一个代码中单行注释的例子:

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

尾端注释

极短的注释可以与它们所要描述的代码位于同一行,但是应该有足够的空白来分开代码和注释。若有多个短注释出现于大段代码中,它们应该具有相同的缩进。
以下是一个代码中尾端注释的例子:

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

行末注释

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


if ($foo > 1) {
 
// 第二种用法.
 
...
}
else {
return false; // 说明返回值的原因
}
//if ($bar > 1) {
 
//
//  // 第三种用法
//  ...
/
			本文地址:http://itbyc.com/php/19900.html
转载请注明出处。
分享是一种快乐,也是一种美德:
博客首页 | WEB开发 | 网站运营 | CMS使用教程 滇ICP备14002061号-1