¿Por qué usar 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 fácilmente entendidos por otros desarrolladores simplemente leyendo los comentarios.
• Como práctica recomendada, debe tener 3 líneas de comentarios por cada 10 líneas de código

En este tutorial, aprenderás

• Comentarios PHP
• include / include_once  + ejemplo
• require / require_once + ejemplo
• PHP include vs require

 

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 barras diagonales dobles // y terminan en la misma línea.
• Los comentarios de varias líneas comienzan con una barra diagonal seguida del asterisco /* y terminan con el asterisco seguido de la barra diagonal */.

El siguiente diagrama muestra un archivo PHP con comentarios de varias líneas y una sola línea Ejemplo de PHP

 

include / include_once

La declaración «include» php se utiliza para incluir otros archivos en un archivo PHP.

Tiene dos variaciones, include e include_once. El intérprete de PHP ignora el comando include_once si se incluye el archivo.

La declaración de inclusión tiene la siguiente sintaxis

<?php
include "nombre_archivo";
?>

 

La instrucción include_once tiene la siguiente sintaxis

<?php
include_once "nombre_archivo";
?>

AQUÍ,

• «Include / include_once» es la declaración que incluye el archivo
• «‘Nombre_archivo'» es el nombre del archivo que se incluirá.

 

Ejemplo: Include / Include_once

Supongamos 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: header.php, index.php

Debajo están los códigos para;

 

header.php

<a href="/index.php"> Inicio </a>
<a href="/aboutus.php"> Sobre nosotros </a>
<a href="/services.php"> Servicios </a>
<a href="/contactus.php"> Contáctenos </a>

index.php

<?php
include 'header.php';
?>

La página anterior index.php generará los links del archivo header.php en su interior, sin tener que añadirlos manualmente. De esta manera, podemos reutilizar ese archivo header.php tantas veces como necesitemos y modificándolo, se modificará en todas las páginas en las que se haya incluido.

 

require / require_once

La declaración require tiene dos variaciones, require y require_once.

La instrucción require / require_once se usa para incluir el archivo.

Require_once se ignora si el archivo requerido ya ha sido agregado por alguna de las cuatro declaraciones de inclusión.

Tiene la siguiente sintaxis

<?php
require 'nombre_archivo';
?>

<?php
require_once 'nombre_archivo';
?>

AQUÍ,

• «Require / require_once» es la declaración que incluye el archivo
• «‘Nombre_archivo'» es el nombre del archivo que se incluirá.

 

Ejemplo: Require

Supongamos que estamos desarrollando una aplicación con 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 utilizando la instrucción require. config.php

<?php
$config['host'] = 'localhost';
$config['db'] = 'my_database';
$config['uid'] = 'root';
$config['contraseña'] = '';
?>

Veamos ahora el código de muestra que requiere el archivo de configuración. Pages_model.php

<?php
require 'config.php';
// requiere el archivo de configuración
// otro código para conectarse a la base de datos
?>

 

include vs require

La diferencia entre include / require

Include	Require
Emite una advertencia cuando se produce un error.	No emite una advertencia.
La ejecución del script continúa cuando se produce un error.	La ejecución del script se detiene cuando se produce un error.

 

En general, se recomienda usar la declaración de inclusión include 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 instrucción require debe usarse si el script completo no puede ejecutarse sin el archivo solicitado.

Las declaraciones «include» y «require» se pueden usar en cualquier línea de los códigos fuente donde desea que aparezca el código.

Resumen

• 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 simplemente actualizando un solo archivo.
• El código PHP, como la configuración de la base de datos, las funciones personalizadas, etc., se pueden compartir en muchas páginas para garantizar que el sitio web / aplicación utilice la misma configuración.
• Los comentarios se utilizan para ayudar a comprender el código fuente. Son para la comprensión humana
• 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 utilizando alguna de las cuatro declaraciones.
• La declaración «include» emite una advertencia y continúa con la ejecución si no se encuentra el archivo solicitado.
• La declaración require genera un error fatal y detiene la ejecución del script.
• La declaración «include» 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 el script completo.