PHP入门基础之注释的写法
作者:孟华328 发布时间:2023-10-20 07:26:17
标签:PHP,注释
1 什么是注释
注释就是对代码的解释和说明,其目的是让人们能够更加轻松地了解代码。注释是编写程序时,写程序的人给一个语句、程序段、函数等的解释或提示,能提高程序代码的可读性。
1.1 注释的目的
注释只是为了提高可读性,不会被计算机编译。
1.2 注释的格式
注释通常会分为行注释和块注释
行注释: 在符号后那一行不会被编译
块注释: 被块注释符号中间的部分不会被编译
2 PHP 的注释格式
PHP 支持 C,C++ 和 Unix Shell 风格(Perl 风格)的注释。例如:
<?php
echo 'This is a test'; // 这是单行 c++ 样式注释
/* 这是一条多行注释
另一行也是注释 */
echo 'This is yet another test';
echo 'One Final Test'; # 这是单行 shell 风格的注释
?>
2.1 行注释
单行注释
C 风格单行注释
<?php
//这是第二行注释
echo "http://c.biancheng.net/php/";
// echo "PHP 注释";
?>
shell 风格单行注释
#这是第一行注释
echo "C语言中文网<br>";
注意:单行注释仅仅注释到行末或者当前的 PHP 代码块,视乎哪个首先出现。这意味着在 // … ?> 或者 # … ?> 之后的 HTML 代码将被显示出来:?> 跳出了 PHP 模式并返回了 HTML 模式,// 或 # 并不能影响到这一点。
<h1>This is an <?php # echo 'simple';?> example</h1>
<p>The header above will say 'This is an example'.</p>
2.2 多行注释
在需要注释的代码块上以/* 开始,以*/结束。
<?php
/*
$a = "这是第一行";
$b = "这是第二行";
$c = "这是第三行";
*/
注意:C 风格的注释在碰到第一个 */ 时结束。要确保不要嵌套 C 风格的注释。
// 错误的写法
// Error: expect statement
/*
echo 'This is a test'; /* 这个注释会引发问题 */
*/
?>
3 小结
合理使用注释应该满足以下几项原则:
注释必须准确、易懂、简洁,错误的注释不但无益反而有害;
注释可以书写在代码中的任意位置,但是一般写在代码的开头或者结束位置;
修改程序代码时,一定要同时修改相关的注释,以保持代码和注释的同步;
在实际的代码规范中,要求注释占程序代码的 20% 左右,即 100 行程序中包含 20 行左右的注释;
避免在注释中使用缩写,特别是不常用缩写;
注释与所描述内容进行同样的缩进,可使程序排版整齐,并方便注释的阅读与理解。
来源:https://blog.csdn.net/alexwei2009/article/details/125107986


猜你喜欢
- 本篇文章主要介绍了Python基于mysql实现学生管理系统,分享给大家,具体如下:import pymysqlimport redef i
- SQL Server 2008支持四种协议,Shared Memory;TCP/IP;Named Pipes和Virtual Interfa
- 本文实例讲述了Python通过for循环理解迭代器和生成器。分享给大家供大家参考,具体如下:迭代器可迭代对象通过 for…in… 循环依次拿
- 本文实例讲述了Python基于递归实现电话号码映射功能。分享给大家供大家参考,具体如下:问题电话按键上面的每个数字都对应着几个字母,如果按下
- 本文实例为大家分享了python3实现qq邮箱登陆并发送邮件功能的具体代码,供大家参考,具体内容如下基于selenium,使用chrome浏
- 1 存储过程1.1 什么是存储过程存储过程是一组为了完成某项特定功能的sql语句集,其实质上就是一段存储在数据库中的代码,他可以由声明式的s
- 本文实例讲述了Python将xml和xsl转换为html的方法。分享给大家供大家参考。具体分析如下:这里需要用libxml2,所以还要先安装
- 大多数卷积神经网络都是直接通过写一个Model类来定义的,这样写的代码其实是比较好懂的,特别是在魔改网络的时候也很方便。然后也有一些会通过c
- 缩略图在很多时候我们都需要将图片按照同比例缩小有利于存储 但是一张张手动去改的话太麻烦了 今天我们就用python实现一个简单的将一个文件夹
- 加载垃圾邮件数据集spambase.csv(数据集基本信息:样本数: 4601,特征数量: 57, 类别:1 为垃圾邮件,0 为
- 前言最近在用python写一个项目,发现一个很恶心的bug,就是同由一个类生成的两个实例之间的数据竟然会相互影响,这让我非常不解。后来联想到
- 啥都不说了,直接奉献原代码 代码如下:'==========注意==================================
- WARNING:低技术力自己无聊写的哥特字体是最好看的:示例代码:#!usr/bin/env python3# -*- coding:UTF
- 常用的 random 模块方法import random# random.random()用于生成一个 0 到 1 的随机浮点数: 0 &l
- 错误出现:导入数据时出现“SqlDateTime 溢出。必须介于 1/1/1753 12:00:00 AM 和 12/31/9999 11:
- 禁用admin中models的编辑链接和添加删除按钮方法如下:class MyModelAdmin(models.ModelAdmin):
- 有个Q友问怎么写个程序能按照要求输入,再输出对应形状的面积?我大概写了几行,没有考虑输出异常,重点想记录下 int 的接收,如下图知识点就两
- 一、数据描述数据集中9994条数据,横跨1237天,销售额为2,297,200.8603美元,利润为286,397.0217美元,他们的库存
- 使用pytorch的dataloader报错:RuntimeError: stack expects each tensor to be e
- 0.目录1.前言2.安装python3.使用pip下载、安装包3.1 安装Scrapy3.2 安装PyQt3.3 同时安装多个包3.4 pi