PHP 注释、Include/Include_once、Require/Require_once
为什么要使用注释?
- 如果您一段时间不接触源代码,很容易忘记代码的作用。注释源代码有助于记住代码的作用。
- 当多个开发人员必须在同一个项目上工作时,注释源代码也非常重要。通过简单地阅读注释,一个开发人员所做的更改可以被其他开发人员轻松理解。
- 作为最佳实践,您每 10 行代码应该有 3 行注释
PHP 注释
下图显示了一个同时包含多行注释和单行注释的 PHP 文件
PHP 示例
PHP Include & PHP Include_once
“include” php 语句用于将其他文件包含到 PHP 文件中。
它有两种变体,include 和 include_once。如果被包含的文件已被包含,PHP 解释器将忽略 include_once。
include 语句的语法如下
<?php include 'file_name'; ?>
include_once 语句的语法如下
<?php include_once 'file_name'; ?>
此处,
- “Include/include_once”是包含文件的语句
- “’file_name’”是要包含的文件名。
示例:Include / Include_once
假设您正在开发一个在所有页面中都包含相同导航菜单的网站。
您可以使用 include 语句创建通用的页眉,然后将其包含在每个页面中。让我们看看如何做到这一点。
- 我们将创建 2 个文件名
- header.php, index.php
以下是代码:header.php
<a href="index.php">Home</a> <a href="aboutus.php">About us</a> <a href="services.php">Services</a> <a href="contactus.php">Contact Us</a>
index.php
<?php include 'header.php'; ?>
上面的页眉页面将输出
PHP Require & PHP require_once
require 语句有两种变体,require 和 require_once。
require/require_once 语句用于包含文件。
如果所需文件已通过这四种 include 语句中的任何一种添加,则会忽略 Require_once。
它具有以下语法
<?php require 'file_name'; ?>
<?php require_once 'file_name'; ?>
此处,
- “require/require_once”是包含文件的语句
- “’file_name’”是要包含的文件名。
示例:Require
假设我们正在开发一个数据库驱动的应用程序。
我们可以创建一个配置文件,并使用 require 语句将其包含在所有连接到数据库的页面中。config.php
<?php $config['host'] = 'localhost'; $config['db'] = 'my_database'; $config['uid'] = 'root'; $config['password'] = ''; ?>
现在让我们看一下需要 config 文件的示例代码。Pages_model.php
<?php require 'config.php'; //require the config file //other code for connecting to the database ?>
PHP include vs require
include / require 之间的区别
Include | Require |
---|---|
发生错误时发出警告 | 不发出警告 |
发生错误时,脚本继续执行 | 发生错误时,脚本停止执行。 |
通常,建议使用 include 语句,以便在发生错误时,脚本会继续执行以显示网站管理员的电子邮件地址或“联系我们”页面。
如果整个脚本在没有请求文件的情况下无法运行,则应使用 require 语句。
“include”和“require”语句可以在源代码的任何位置使用,只要您希望代码出现在那里。
摘要
- 单个 HTML 代码,如页眉、页脚、侧边栏等,可以在多个页面之间共享。这使得只需更新单个文件即可轻松更新网站。
- PHP 代码(如数据库配置设置、自定义函数等)可以在多个页面之间共享,确保网站/应用程序使用相同的设置。
- 注释用于帮助理解源代码。它们是为了人类理解
- 单行注释语句以双斜杠//开头。
- 多行注释语句用 /* 语句 */ 括起来。
- “include, include_once, require 和 require_once”语句用于包含文件。
- 如果请求的文件已通过这四种语句中的任何一种包含,则 Include_once/require_once 将被忽略。
- 如果找不到请求的文件,“include”语句会发出警告并继续执行。
- require 语句会引发致命错误并停止脚本执行。
- 在大多数情况下应使用“include”语句,除非在没有要包含的请求文件的情况下,整个脚本无法运行。