Comentarios PHP, Incluir/Incluir_once, Requerir/Requerir_once
¿Por qué utilizar comentarios?
- Si no trabaja en el código fuente durante algún tiempo, es fácil olvidar lo que hace el código. Comentar el código fuente ayuda a recordar lo que hace el código.
- Comentar el código fuente también es muy importante cuando varios desarrolladores tienen que trabajar en el mismo proyecto. Los cambios realizados por un desarrollador pueden ser entendidos fácilmente por otros desarrolladores simplemente leyendo los comentarios.
- Como práctica recomendada, debes tener 3 líneas de comentarios por cada 10 líneas de código.
Comentarios PHP
- Los comentarios nos ayudan a entender el código.
- Los comentarios son explicaciones que incluimos en nuestro código fuente. Estos comentarios son para la comprensión humana.
- Los comentarios de una sola línea comienzan con dos barras diagonales // y terminan en la misma línea.
-
- Los comentarios de varias líneas comienzan con una barra diagonal seguida de un asterisco /* y terminan con un asterisco seguido de una barra diagonal */.
-
El siguiente diagrama muestra un archivo PHP con comentarios de varias líneas y de una sola línea.
Ejemplo de PHP
PHP incluye y PHP incluye_once
La declaración php "incluir" se utiliza para incluir otros archivos en un archivo PHP.
Tiene dos variaciones, incluir e incluir_once. El intérprete de PHP ignora Include_once si el archivo que se va a incluir.
La declaración de inclusión tiene la siguiente sintaxis
<?php include 'file_name'; ?>
La declaración include_once tiene la siguiente sintaxis
<?php include_once 'file_name'; ?>
AQUÍ,
- “Include/include_once” es la declaración que incluye el archivo
- “'file_name'” es el nombre del archivo que se incluirá.
Ejemplo: Incluir/Incluir_once
Suponga que está desarrollando un sitio web que contiene el mismo menú de navegación en todas las páginas.
Puede crear un encabezado común y luego incluirlo en cada página usando la declaración de inclusión. Veamos cómo se puede hacer esto.
- Crearemos 2 nombres de archivos.
- encabezado.php, índice.php
A continuación se muestran los códigos para; 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'; ?>
La página de encabezado de arriba generará
PHP requiere y PHP require_once
La declaración require tiene dos variaciones, require y require_once.
La declaración require/require_once se utiliza para incluir el archivo.
Require_once se ignora si cualquiera de las cuatro declaraciones de inclusión ya ha agregado el archivo requerido.
Tiene la siguiente sintaxis
<?php require 'file_name'; ?>
<?php require_once 'file_name'; ?>
AQUÍ,
- “require/require_once” es la declaración que incluye el archivo
- “'file_name'” es el nombre del archivo que se incluirá.
Ejemplo: Requerir
Supongamos que estamos desarrollando una aplicación basada en una base de datos.
Podemos crear un archivo de configuración que podemos incluir en todas las páginas que se conectan a la base de datos usando la declaración require. configuración.php
<?php $config['host'] = 'localhost'; $config['db'] = 'my_database'; $config['uid'] = 'root'; $config['password'] = ''; ?>
Veamos ahora el código de muestra que requiere el archivo de configuración. Páginas_modelo.php
<?php require 'config.php'; //require the config file //other code for connecting to the database ?>
PHP incluye vs requiere
La diferencia entre incluir/requerir
Incluir | Exigir |
---|---|
Emite una advertencia cuando ocurre un error | No emite una advertencia |
La ejecución del script continúa cuando ocurre un error. | La ejecución del script se detiene cuando se produce un error. |
Generalmente, se recomienda utilizar la declaración de inclusión para que cuando ocurra un error, la ejecución del script continúe mostrando la dirección de correo electrónico del webmaster o la página de contacto.
La declaración require debe usarse si no se puede ejecutar todo el script sin el archivo solicitado.
Las declaraciones "incluir" y "requerir" se pueden usar en cualquier línea de los códigos fuente donde desee que aparezca el código.
Resum
- El código HTML único, como encabezados, pies de página, barras laterales, etc., se puede compartir en muchas páginas. Esto facilita la actualización del sitio web con solo actualizar un solo archivo.
- Código PHP como los ajustes de configuración de la base de datos, funciones personalizadas, etc., se pueden compartir en muchas páginas, lo que garantiza que el sitio web/la aplicación utilice la misma configuración.
- Los comentarios se utilizan para ayudar a comprender el código fuente. Son para el entendimiento humano.
- Las declaraciones de comentarios de una sola línea comienzan con barras diagonales dobles //.
- Las declaraciones de comentarios de varias líneas están encerradas entre /* declaraciones */.
- Las declaraciones "include, include_once, require y require_once" se utilizan para incluir archivos.
- Include_once/require_once se ignora si el archivo solicitado ya se ha incluido mediante cualquiera de las cuatro declaraciones.
- La declaración "incluir" emite una advertencia y continúa con la ejecución si no se ha encontrado el archivo solicitado.
- La declaración require genera un error fatal y detiene la ejecución del script.
- La declaración "incluir" debe ser en la mayoría de los casos, excepto en situaciones en las que sin el archivo solicitado para incluir, no se puede ejecutar todo el script.