Cómo instalar phpDocumentor correctamente
phpdoc.
1. ¿Qué es phpDocumentor?
PHPDocumentor es una herramienta escrita en PHP, que se utiliza para generar rápidamente documentación API con referencias cruzadas, índices y otras funciones para programas PHP con anotaciones de especificación. La versión anterior es phpdoc, que pasó a llamarse phpDocumentor desde 1.3.0. La nueva versión agrega soporte para la sintaxis php5 y puede generar documentos en el navegador del cliente. Los documentos se pueden convertir a PDF y HTML. , CHM de varios formularios, muy conveniente.
Cuando PHPDocumentor funciona, escaneará el código fuente PHP en el directorio especificado, escaneará las palabras clave, interceptará los comentarios que deben analizarse y luego analizará las etiquetas especiales en los comentarios para generar.
archivo xml y luego establezca un índice correspondiente para generar un archivo xml basado en la clase analizada y la información del módulo. Para el archivo xml generado, use una plantilla personalizada para generarlo en un archivo en el formato especificado.
2. Instalación de phpDocumentor
Al igual que otros módulos de Pear, la instalación de phpDocumentor también se divide en dos métodos: instalación automática e instalación manual. Ambos métodos son muy convenientes:
a. Instalar automáticamente a través de pear
Ingrese en la línea de comando
pear install PhpDocumentor
b. Instalación manual
En "gt; Baidu lt ; /agt;
, puedes escribir @license
Baidu
@link
similar a licencia
contenido, pero también puede hacer referencia a cualquier palabra clave en el documento a través del enlace
@nombre
Especifique el alias de la palabra clave
@paquete
Uso: nivel de página -gt;
definir, función, incluir
nivel de clase -gt; clase, var, métodos
Usado. Agrupa lógicamente una o más palabras clave
@abstrcut
Indica que la clase actual es una clase abstracta
@param
Especifica los parámetros de la función
@return
Especifica el valor de retorno del método o función
@static
Especifica que las palabras que no son constructoras son estáticos
@var
Especifica el tipo de variable
@version
Especifica la versión
Especifica qué se debería haber hecho mejor, o qué no se hizo
@throws
Especifica los errores que puede arrojar la función, y los casos más probables
@throws
Especificar esta función generará un error p>
Como se mencionó anteriormente, las etiquetas de marcado de documentos normales deben comenzar en cada línea con marca @.
Además, también existe una etiqueta llamada inline
tag, representada por {@}, que consta del siguiente contenido:
{@link}
Usar métodos y @link
{@source}
Mostrar el contenido de funciones o métodos
6 Algunas especificaciones de comentarios
a. Los comentarios deben aparecer en formato
"..." o
"...". Los comentarios deben ser
b. Las funciones que hacen referencia a variables globales deben usar etiquetas glboal.
c. Para las variables, sus tipos (int, string, bool...) deben marcarse con var.
d. y devuelve.
e. Para las palabras clave que aparecen dos o más veces, use ingore para ignorar las palabras clave redundantes y mantenga solo una
f. Cuando llame a otras funciones o clases, use LINK. u otras etiquetas para vincular a las secciones apropiadas y hacer que el documento sea más fácil de leer. Esto hará que el documento sea más fácil de leer.
g. Utilice comentarios que no sean de documentación cuando sea necesario para mejorar la legibilidad del código.
h. El contenido descriptivo debe ser lo más conciso posible, utilizando frases en lugar de oraciones siempre que sea posible.
i. Las variables globales, las variables estáticas y las constantes deben marcarse con las descripciones correspondientes
7. Resumen
phpDocumentor es una herramienta muy poderosa para generar documentos automáticamente. usarlo puede ayudarnos a escribir comentarios estandarizados y generar documentos claramente estructurados y fáciles de entender, lo cual es muy útil para nuestras actualizaciones de código, mantenimiento, entrega, etc. }
clase miclase {
var $firstvar = 6;
var $segundovar =
array(
'cosas' =gt;
array(
6,
17,
'armadillo'
),
prueba =gt;
función miclase() {
$this-gt;
7; /p>
}
función parentfunc($paramie)
{
if ($paramie) {
return 6 ;
} else {
devolver nueva babyclass;
}
}
}
clase babyclass extiende miclase
{
var $segundovar = 42;
var $terceravar;
función babyclass() {
padre::miclase();
$this-gt; firstvar;
}
función parentfunc($paramie)
{
devolver nueva miclase )
}
}
} gt;