Page 44 - Programador-PHP

Programación Procedural de Aplicaciones Web de baja complejidad
PHP Experto – Tomo I Eugenia Bahit

Comentando y documentando el

código fuente

Una de las prácticas más recomendadas, consiste en
"comentar" el código fuente. Comentar el código, significa
"escribir referencias sobre el código fuente que nos ayuden a
entenderlo".

En PHP, existen dos tipos de comentarios:
1. Los comentarios de una sola línea

2. Los comentarios de varias líneas (o docstrings)

Los comentarios de una sola línea, pueden escribirse
antecedidos de una doble barra diagonal (//) o una almohadilla
(#):

<?php
// alícuota del IVA (en porcentaje)
$alicuota_iva = 21;
// Datos del producto
$codigo_de_producto = 1284;
$nombre_producto = "Agua Mineral Manantial x 500 ml";
$precio_bruto = 3.75; # precio sin IVA
// Cálculos relacionados al IVA
$iva = 3.75 * 21 / 100;
$precio_neto = $precio_bruto + $iva; # Precio con IVA incluido
?>

Otra utilidad de comentar el código fuente, es recomendarnos
aquello que nos queda por hacer. Para ello, se utiliza la palabra
TODO (del inglés "to do" que en español significa "por hacer")
al comentario:

<?php
// alícuota del IVA (en porcentaje)
$alicuota_iva = 21;
// Datos del producto
$codigo_de_producto = 1284;

44