PHP规范的注释方法大全

Mrzhou
Mrzhou
Mrzhou
259
文章
1
评论
2020年5月30日00:51:17 评论 1,329

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

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>

块注释

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

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

/*  
* 这里是块注释
*/

块注释可以以/*-开头,这样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) {
  
//
//  // 第三种用法
//  ...
//}
//else {
// return false;
//}

文档注释

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

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

注意

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

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

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

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

继续阅读
Mrzhou
  • 本文由 发表于 2020年5月30日00:51:17
  • 转载请务必保留本文链接:https://zhouxiaosong.com/764.html
PHP SPL 标准库之 Countable 脚本编程

PHP SPL 标准库之 Countable

本文实例讲述了PHP标准库 (SPL)——Countable用法。分享给大家供大家参考,具体如下: 类实现 Countable 可被用于 count() 函数. 接口摘要 Countable { /*...
苹果mac系统如何配置apache与php? 操作系统

苹果mac系统如何配置apache与php?

在Mac环境下系统本身就带有的Apache(阿帕奇服务器)和PHP都预装好了. 下面我们逐步来操作Apache和PHP的合并: 第一步:查看系统预装的阿帕奇和PHP版本 (1)打开终端,输入命令:su...
php怎么对图片不同尺寸显示 脚本编程

php怎么对图片不同尺寸显示

一张图片可能会在不同的地方显示,大小不同,比例也不同,因此本例介绍的这个图片自动裁切还是比较有用的,有需求的朋友可以看看。 如果做过那种门户站的朋友,肯定知道,一张图片可能会在不同的地方显示、大小不同...
分析PHP程序运行性能(消耗) 脚本编程

分析PHP程序运行性能(消耗)

php在使用了xdebug后,可以配置xdebug相关的配置,生成运行的日志。本文就是关于PHP程序运行性能的分析,感兴趣的朋友可以了解一下。 在php.ini中配置: xdebug.profiler...
匿名

发表评论

匿名网友 填写信息

:?: :razz: :sad: :evil: :!: :smile: :oops: :grin: :eek: :shock: :???: :cool: :lol: :mad: :twisted: :roll: :wink: :idea: :arrow: :neutral: :cry: :mrgreen: