Documentar las clases en PHP - Historial de revisiones

Veiga: Página creada con «Es muy recomendable comentar las clases y métodos que programamos en nuestro código. Por ejemplo:
2019-10-15T17:45:45Z

Página creada con «Es muy recomendable comentar las clases y métodos que programamos en nuestro código. Por ejemplo: <syntaxhighlight lang="php"> <?php // Ejemplo de comentario de cabecer…»

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

Por ejemplo:

<syntaxhighlight lang="php">
<?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;
}

}
?>
</syntaxhighlight>

[http://pear.php.net/manual/en/standards.sample.php Ver el siguiente ejemplo completo documentado.]