请选择 进入手机版 | 继续访问电脑版
查看: 121|回复: 0

PHP入门基础之注释的写法

[复制链接]

2066

主题

2066

帖子

6594

积分

管理员

Rank: 9Rank: 9Rank: 9

积分
6594
发表于 2022-10-9 01:05:37 | 显示全部楼层 |阅读模式
1 什么是注释

注释就是对代码的解释和说明,其目的是让人们能够更加轻松地了解代码。注释是编写步调时,写步调的人给一个语句、步调段、函数等的解释或提示,能提高步调代码的可读性。

1.1 注释的目的

注释只是为了提高可读性,不会被计算机编译。

1.2 注释的格式

注释通常会分为行注释和块注释

  • 行注释: 在符号后那一行不会被编译
  • 块注释: 被块注释符号中间的部门不会被编译

2 PHP 的注释格式

PHP 支持 C,C++ 和 Unix Shell 风格(Perl 风格)的注释。例如:
  1. <?php
  2.     echo 'This is a test'; // 这是单行 c++ 样式注释
  3.     /* 这是一条多行注释
  4.        另一行也是注释 */
  5.     echo 'This is yet another test';
  6.     echo 'One Final Test'; # 这是单行 shell 风格的注释
  7. ?>
复制代码
2.1 行注释

单行注释
C 风格单行注释
  1. <?php
  2.     //这是第二行注释
  3.     echo "http://c.biancheng.net/php/";
  4.     // echo "PHP 注释";
  5. ?>
复制代码
shell 风格单行注释
  1.    #这是第一行注释
  2.     echo "C语言中文网<br>";
复制代码
注意:单行注释仅仅注释到行末或者当前的 PHP 代码块,视乎哪个首先出现。这意味着在 // … ?> 或者 # … ?> 之后的 HTML 代码将被显示出来:?> 跳出了 PHP 模式并返回了 HTML 模式,// 或 # 并不能影响到这一点。
  1. <h1>This is an <?php # echo 'simple';?> example</h1>
  2. <p>The header above will say 'This is an example'.</p>
复制代码
2.2 多行注释

在需要注释的代码块上以/* 开始,以*/结束。
  1. <?php
  2.         /*
  3.             $a = "这是第一行";
  4.             $b = "这是第二行";
  5.             $c = "这是第三行";
  6.         */
复制代码
注意:C 风格的注释在碰到第一个 */ 时结束。要确保不要嵌套 C 风格的注释。
  1. // 错误的写法
  2. // Error: expect statement
  3. /*
  4.    echo 'This is a test'; /* 这个注释会引发问题 */
  5. */
  6. ?>
复制代码
3 小结

合理使用注释应该满足以下几项原则:

  • 注释必须准确、易懂、简洁,错误的注释不光无益反而有害;
  • 注释可以书写在代码中的任意位置,但是一般写在代码的开头或者结束位置;
  • 修改步调代码时,一定要同时修改相关的注释,以保持代码和注释的同步;
  • 在实际的代码规范中,要求注释占步调代码的 20% 左右,即 100 行步调中包罗 20 行左右的注释;
  • 制止在注释中使用缩写,特别是不常用缩写;
  • 注释与所描述内容进行同样的缩进,可使步调排版整齐,并方便注释的阅读与理解。
到此这篇关于PHP入门基础之注释的写法的文章就介绍到这了,更多相关PHP注释内容请搜索趣UU以前的文章或继续浏览下面的相关文章希望大家以后多多支持趣UU!

免责声明:如果侵犯了您的权益,请联系站长,我们会及时删除侵权内容,谢谢合作!
打赏作者
  • 0
  • 0
  • 0
  • 0
回复

使用道具 举报

您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

快速回复 返回顶部 返回列表