首页 > 代码库 > php 注释 规范
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 注释 规范
声明:以上内容来自用户投稿及互联网公开渠道收集整理发布,本网站不拥有所有权,未作人工编辑处理,也不承担相关法律责任,若内容有误或涉及侵权可进行投诉: 投诉/举报 工作人员会在5个工作日内联系你,一经查实,本站将立刻删除涉嫌侵权内容。