Documentar las clases en PHP

De Manuais Informática - IES San Clemente.
Ir a la navegación Ir a la búsqueda

Es muy recomendable comentar las clases y métodos que programamos en nuestro código.

Por ejemplo:

<?php
// Ejemplo de comentario de cabecera de un fichero de una clase:
/**
 * Esta clase realiza operaciones matemáticas.
 *
 * @author Rafa Veiga <rafa@dominio.com>
 * @copyright 2013
 * @license ruta/a/license.txt GPL
 */ 
class Match{

....
}

// Ejemplo de comentario de un método dentro de una clase.

class Math{




/**
 * Añade tantos argumentos como desees (int), y este método calculará la suma
 * @return int La suma de todos los argumentos
 */
function add(){
   .......
   return $suma;
}



}
?>

Ver el siguiente ejemplo completo documentado.