PHP 注释规范

简介: 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,这是单行注释

Buy me a cup of coffee :)

目录
相关文章
|
2月前
进入靶场,出现一张照片,右击查看源代码,发现有一个注释的source.php文件
这段代码实现了一个网站上弹出的促销海报动画效果,包含一个关闭按钮。当促销海报弹出时,会在三秒后开始抖动一两下。海报使用固定定位居中显示,带有阴影和圆角,关闭按钮位于右上角。可以通过修改时间参数调整弹出时间。
20 0
|
PHP
PHP - Laravel Blade模板注释 {{-- 注释 --}} 与 <!-- 注释 --> 的区别
PHP - Laravel Blade模板注释 {{-- 注释 --}} 与 <!-- 注释 --> 的区别
96 0
|
6月前
|
算法 程序员 Shell
PHP注释
PHP注释
48 0
|
11月前
|
小程序 PHP Perl
vscode设置php自定义注释格式
写代码一般的注释都是有格式的,方便自己和他人阅读代码,多人开发的时候,也能更快的找到这部分代码是由谁来编写的。 好的代码注释确实是一个好习惯,但是,有的时候就是这玩意有敲起来有点费劲~
230 0
|
PHP
vscode添加PHP代码注释的插件及设置教程
在vscode中点击扩展-->安装插件koroFileHeader
542 0
PHP的代码格式规范
PHP的代码格式规范
139 0
|
XML 开发框架 JavaScript
【web 开发基础】php 开发基础快速入门 (3)-PHP程序符号标记和程序注释的使用及空白符详解
以<?php开始和以 ?>结束的标记是标准风格的标记,属于xml风格,这也是PHP推荐使用的标记形式,服务器管理员不能禁用这种风格的标记,如果将PHP嵌入到XML或者XHTML中,则需要使用<?php?>以保证符合标准,如果没有特殊要求,在开发过程中一般默认使用此风格. 以<script language="php">开始和以</script>结束是长风格标记,这种标记是最长的,这种用法就是javascript和vbscript等脚本语言的写法,如果你使用的html编辑器无法使用其他风格的标记可以使用这个标记来界定PHP代码,不过这在日常开发中是比较少用的. 以<?开始和以?>结束的标记是最简
251 1
|
SQL IDE PHP
php对象字段声明,easyswoole ORM 快速生成注释
在PHPSTORM IDE中,我们可以通过注释给类写明可调用字段名,这样子才有语法提示。 比如在Thinkphp中,虽然允许我们可以通过对象属性方式去调用,但是并没有语法提示。 添加注释后 就舒服很多了。
134 0
php对象字段声明,easyswoole ORM 快速生成注释
PHP注释php中的注释分为两种:注释和块注释
行注释:一次注释一行 //: 后面跟的所有内容都是注释
74 0