PHP编码规范之注释规范

  作者:bea

注释在每种语言中都有,理解不同的注释类型之间的区别是很重要的。有些注释是方便程序员阅读程序的,但是有些注释的内容实际上是和程序一起存储的。 先来看看PHP的注释类型有哪些。 1、单行注释 如下代码就是PHP中的单行注释: 上面注释是PHP代码的单行注释 2、多行注释 如下代码是PHP代码的多行注释 3、文档注释 如下代码是PHP代码的文档注释 多行注释和文档注释初看起来没有
注释在每种语言中都有,理解不同的注释类型之间的区别是很重要的。有些注释是方便程序员阅读程序的,但是有些注释的内容实际上是和程序一起存储的。
先来看看PHP的注释类型有哪些。

1、单行注释
如下代码就是PHP中的单行注释:
上面注释是PHP代码的单行注释

2、多行注释
如下代码是PHP代码的多行注释

3、文档注释
如下代码是PHP代码的文档注释

多行注释和文档注释初看起来没有什么不同,但是文档注释多了一个“*”号。但是PHP会以不同的方式来解析多行注释和文档注释。
单行注释仅仅是方便人来读程序,但是对PHP来说没有多大意义。
多行注释就多了一些额外的工作,多行注释的数据和程序代码会在一块存储,这些数据可能会被其他的程序使用,这是为了获得关于如何与程序打交道的更多信息。

值得注意的是:文档注释的要求非常的严格,一定要把文档注释放在说明代码的前面,否则他们是不会关联在一起的。

所以在自己编写代码的过程中不要小看了注释,它其实也是非常重要的。想成为一名高级PHP程序员,小地方注意了,代码的效率等各方面都会有一定的提高。
在团队合作中代码规范是相当重要的,希望PHP程序员们不要遗漏小的方面。 有用  |  无用

猜你喜欢