PHP注释

注释(Comments)是指在程序编写过程中,对程序文件或者代码片段额外添加的一个备注说明。通过注释可以提高代码可读性,让自己或其他开发人员更快速地理解程序的。

注释在程序编程中非常重要,恰当的注释程序不仅是程序员的个人习惯,更是责任的体现。但在实际过程中,大部分程序员都没有良好的对程序进行注释习惯,这往往会在日后对自己或他人造成相当大的麻烦。

PHP 注释不属于 PHP 程序的一部分,其内容也不参与程序中的任何功能计算,在编辑器中以特殊颜色(如绿色)显示。

PHP 注释符号

PHP 支持 C++,C 和 Unix Shell 风格(Perl 风格)的注释,所以也产生了 3 种PHP注释符号:

  • C++ 风格:// 这是 C+ 风格的注释
  • C 风格:/* 这是 C 风格的注释 */
  • Unix Shell 风格:# 这是 Unix Shell 风格的注释

一般大家都习惯使用 C 风格与 C++ 风格的注释。

PHP 注释格式

PHP 注释格式分为单行注释与多行注释。

1.PHP 单行注释

以上三种符号都可用于单行注释,只是使用 // 或 # 注释符时,注释符号后面的文本(本行内)都被视作注释内容,而 /* */ 风格注释符必须以 */ 结尾。

例子:

<?php
// 这是单行注释
echo ‘你好!‘; // 这是单行注释,写在一行代码后面也叫行尾注释
/* 这个注释风格也不错 */
# 较少用的风格
?>

上面的行尾注释,通常只是对本行前面的内容进行注释,单写一行的注释可能是对下面的一行或多行代码进行注释,也可能是为了程序的整体美观。

2.PHP 多行注释

多行注释一般使用 C 风格注释符,以 /* 开头,*/ 结尾来包含多行注释内容:

<?php
echo "你好!";
/*
这是多行大块注释
这里面都是注释内容
更多注释内容等
*/
?>

注意:不要嵌套使用 C 风格注释符,因为在碰到第一个 */ 时系统即认为该段注释结束,在注释掉一大块代码时很容易出现该错误。如下述用法将产生 PHP语法错误:

<?php
echo "你好!";
/*
这是多行大块注释
这里面都是注释内容
更多注释内容等
*/
?>

也可以多次使用 // 符号来注释多行代码,但一般只限于有限的几行:

<?php
echo "你好!";
/*
这是多行大块注释
这里面都是注释内容
更多注释内容等
*/
?>

提示:PHP 注释中不能包含 PHP 代码结束符即:?>,因为在任何地方,PHP 检测到该结束符,即认为该段 PHP 代码结束而跳出 PHP 的执行。

原文地址:http://www.manongjc.com/php/php_comment.html

php相关阅读:

php sscanf() 函数使用方法与实例讲解

php 使用filter_var() 函数来检测url是否包含查询字符串

php 检测是否为IPv6地址

php 使用filter_var() 函数检测一个数字是否在一个范围内

php ajax怎么判断网络连接断开

时间: 2024-08-25 17:18:00

PHP注释的相关文章

Python_01_变量_注释_input_if_缩进

个人笔记,仅作学习记录,如有错误烦请指正 变量命名规则: 1:变量名必须以英文字母.下划线.数字组成的组合2:变量名开头不能是数字3:变量名不能是Python中的关键字4:变量名不能是中文5:Python中的变量名如有多个单词建议下划线连接(其他语言常用驼峰法)6:Python中无法定义常量:在python里面所有的变量都是可变的,所以用全大写的变量名来表示常量 变量赋值:name1 = "laowang"name2 = name1name1 = "xiaozhang&quo

Java-认识变量、注释并能及时发现错误

package com;//变量的演示public class VarDemo { public static void main(String[] args) { /* * 1)题目不用抄 2)注释不用写 3)有错必须改 * * 练习: * 1)声明一个整型的变量,名为a * 声明两个整型的变量,名为b,c * 2)声明整型变量d并赋值为56 * 声明整型变量e, * 给变量e赋值为56 * 3)声明整型变量f并赋值为5, * 声明整型变量g并赋值为f+20,输出g * 声明整型变量h并赋值为

HTML5 &lt;ruby&gt;注释标签

今天学了HTML5的ruby标签,觉得挺有趣的,来记录一下. ruby可以作注释标签,内部有rp和rt标签. <ruby>  标记定义注释或音标. <rp>    告诉那些不支持ruby元素的浏览器该如何显示. <rt>      标记定义对ruby注释的内容文本. 学完这个标签的第一反应就是,我有方法给那些不会读的日语单词做假名注释啦!!! 代码如下,来给一句日语做个小注释: <!DOCTYPE html> <html lang="en&q

IE条件注释

条件注释是IE专门提供的一种语法,其他浏览器会将其作为注释而忽略这些语句. 作用:根据不同的IE版本加载对应的CSS或者JS文件,甚至css代码和html代码. 重要提示 自IE10起,标准模式不再支持条件注释.而是采用特征检测给浏览器不支持的功能来提供备用策略.有关标准模式的详细信息,请参阅定义文档兼容性. 术语 熟悉下列术语有助于你学习文档兼容性. 名词 描述 expression 由运算符.特征和(或)值组合形成一个条件语句 downlevel browser 任何浏览器除了IE5+,其他

Java注释

注释(commentary )是程序中用于说明和解释的一段文字对程序运行不起作用.程序 中添加注释的目的是增强程序的可读性. Java提供3种注释方式:. 单行注释:// 多行注释/**/ 文档注释: /** *文档注释用于从源代码自动生成文档执行javadoc *命名根据源代码中的内容生成网页 *@XXX <-- 可以加入javadoc参数产生相应的文档 */ 不同格式的注释可以嵌套. // Welcome1.java. Text-printing program. /*计信学院09软件工程2

Eclipse注释模板设置详解

设置注释模板的入口:Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素.本文现就每一个元素逐一给大家介绍一下. 文件(Files)注释标签: 1 2 3 4 5 6 7 8 /** * @Title: ${file_name} * @Package ${package_name} * @Description: ${todo}(用一句话描述该文件做什么) * @author $

delphi 属性 参数 新注释

delphi 属性 参数 新注释,在写代码的时候,可以自动看到属性.参数的的备注说明,太方便了. Tmyclass=class /// <summary> /// 姓名 /// </summary> name:string; /// <summary> /// 性别 /// </summary> sex:string; end; var aclass: Tmyclass; begin aclass.name; aclass.sex; 鼠标放上去的时候提示 写

vi/vim多行注释和取消注释

多行注释: 1. 进入命令行模式,按ctrl + v进入 visual block模式,然后按j, 或者k选中多行,把需要注释的行标记起来 2. 按大写字母I,再插入注释符,例如// 3. 按esc键就会全部注释了 取消多行注释: 1. 进入命令行模式,按ctrl + v进入 visual block模式,按字母l横向选中列的个数,例如 // 需要选中2列 2. 按字母j,或者k选中注释符号 3. 按d键就可全部取消注释 对单行注释:CTRL_C对多行注释: 先”V”,进入块选择模式.选择一段代

Qt的语法高亮类(注释方式)

1 //语法高亮---QSyntaxHighlighter 2 //highlighter.h 3 class Highlighter : public QSyntaxHighlighter //定义一个类继承自QSyntaxHightliaghter 4 { 5 Q_OBJECT //Qt宏定义,使用Qt元编程 6 7 public: 8 Highlighter(QTextDocument *parent = 0); //构造函数,传递一个QTextDocument对象给其父类 9 10 pr

QT学习 之 对话框 (四) 字体对话框、消息对话框、文件对话框、进程对话框(超详细中文注释)

QMessageBox类: 含有Question消息框.Information消息框.Warning消息框和Critical消息框等 通常有两种方式可以来创建标准消息对话框: 一种是采用“基于属性”的API,一种是使用QMessageBox的静态方法. 后者书写容易,但缺少灵活性,针对用户给出的提示的信息不够丰富,并且不能自定义消息对话框里面的按钮提示信息.因此推荐第一种写法. [cpp] view plaincopy <span style="font-size:18px;"&