php中几种注释规范

注释在写代码的过程中非常重要，好的注释能让你的代码读起来更轻松，在写代码的时候一定要注意注释的规范。

php里面常见的几种注释方式：

1.文件头的注释，介绍文件名，功能以及作者版本号等信息

/**
*文件名简单介绍
*
*文件功能。
* @author      alvin 作者
* @version     1.0 版本号
*/

2.函数的注释，函数作用，参数介绍及返回类型

/**
* 函数的含义说明
*
* @access public
* @param mixed $arg1 参数一的说明
* @param mixed $arg2 参数二的说明
* @param mixed $mixed 这是一个混合类型
* @return array 返回类型
*/

3.类的注释，类名及介绍

/**
* 类的介绍
*
* 类的详细介绍（可选。）。
* @author      alvin 作者
* @version     1.0 版本号
*/

4.多行注释

/* php注释语法这是多行注释。*/

5.单行注释

$n = 10; //数量n，这是单行注释

php中几种注释规范相关推荐

.NET四种注释规范
不要小瞧注释,因为自己写的Code在很长时间后在修改时,可能连自己都记不得了,还有在其他人接手自己的Case的时候,也会造成阅读困难: .NET提供四种注释一:类注释-在类的开始部分注释 ...
Pycharm中三种注释
"""注释"""'''注释'''\# 注释前两种不是真正的注释,知识字符串的另一种表现形式,例如会被用于写__doc__等长字符串的时候起 ...
PHP中两种包含文件方式、三种注释风格、四种标记风格
2019独角兽企业重金招聘Python工程师标准>>> 一.两种包含文件的方式 ①require语法格式:require("文件名"):这个函数通常放在PHP程序 ...
mysql中的四种注释
mysql中的四种注释 NO1:-- 注释内容这种注释方法不能够实现多行注释,要注意的是 --后面是有一个空格的.(-- 后面的内容将不会被识别,因此需要在下一行加上分号来结束该语句) NO2:#注 ...
C语言中三种大括号格式的规范
C语言中三种大括号格式的使用规范简介: 在C中,使用大括号的方法无所谓对还是错--只要每个开括号后都有一个闭括号,你的程序中就不再会出现与大括号有关的问题.然而,有三种著名的大括号格式:Kernig ...
html中注释的正确写法,HTML 注释规范
遵循标准 HTML注释规范写法应该遵循以下标准: Comments must start with the four character sequence U+003C LESS-THAN SIGN, ...
python编码规范手册-Python官方竟然给出了一种编码规范PEP 8
写在之前每个人都有自己的代码风格,随着写的行数增加,自己对于代码的审美也会变的不一样,这就像是一个逐渐蜕变的过程,每过一段时间回头再去看看自己之前写的代码就会生出一种「这么丑的玩意儿竟然是我写的」这 ...
详细聊聊Javadoc注释规范
Javadoc 注释规范 1. 注释分类 2. Java文档和Javadoc 3. 文档注释的格式 3.1 文档和文档注释的格式化 3.2 文档注释的三部分 4. 使用Javadoc标记 4.1 ...
c++ doxygen 注释规范_[代码规范]Go语言编码规范指导
本规范旨在为日常Go项目开发提供一个代码的规范指导,方便团队形成一个统一的代码风格,提高代码的可读性,规范性和统一性.本规范将从命名规范,注释规范,代码风格和 Go 语言提供的常用的工具这几个方面做一 ...

php中几种注释规范

php中几种注释规范相关推荐

最新文章

热门文章