Difference between revisions of "Cómo documentar un Proyecto en PHP con NetBeans"
Jump to navigation
Jump to search
Line 33: | Line 33: | ||
== Generar la documentación == | == Generar la documentación == | ||
Una vez terminada la documentación de cada función y de todas las páginas php que necesita | Una vez terminada la documentación de cada función y de todas las páginas php que necesita. | ||
a la pestaña '''Window->Projects(Ctrl+1)''', donde nos listará todos los proyectos que tenemos en nuestro NetBeans | # Ir a la pestaña '''Window->Projects(Ctrl+1)''', donde nos listará todos los proyectos que tenemos en nuestro NetBeans. | ||
Luego de hacer los pasos anteriores, volver hacer click derecho a nuestro proyecto y presionar '''“Generate Documentation”'''. | # Hacer click derecho encima de nuestro proyecto el cuál hemos documentado y presionar en '''“Properties”''', en la sección de '''“Categories”''' ir a '''“ApiGen”''' | ||
NetBeans genera la documentación y la muestra en nuestro navegador por defecto, la url sería '''file:///var/www/nombre_proyecto/carpeta_documentación/index.html''', aquí encontraremos la lista de todas las clases y sus funciones documentadas. | # En '''“Target Directory”''' debemos indicar la carpeta en donde se generará nuestra documentación (es recomendable crear una carpeta nueva “documentación” dentro del mismo proyecto) y ok. | ||
# Luego de hacer los pasos anteriores, volver hacer click derecho a nuestro proyecto y presionar '''“Generate Documentation”'''. | |||
# NetBeans genera la documentación y la muestra en nuestro navegador por defecto, la url sería '''file:///var/www/nombre_proyecto/carpeta_documentación/index.html''', aquí encontraremos la lista de todas las clases y sus funciones documentadas. |
Revision as of 13:31, 26 March 2014
Configuración Netbeans
Ingresar a la pestaña Profile -> Options.
PHP
ApiGen
- ApiGen Script: /usr/local/netbeans-7.3/apigen/apigen.php
Comenzar a documentar
Para las Clases
- En la línea anterior de cada clase escribir /**.
- En la siguiente línea poner * una breve descripción de la clase
- La tercer línea terminar la documentación con un */.
Para las Funciones
- En la línea anterior de cada función escribir /** y presionar la tecla enter.
- Netbeans creará una lista de parámetros utilizados en la función, cada uno con el tipo y su nombre, les aparecerá algo como esto: * @param type $nombre, lo que se debe cambiar es el type, por el tipo de dato (ej:string,array,etc) y después de $nombre en la misma línea escribir que contiene este dato(ej:nombre del usuario).
- En la línea posterior a /**, escribir una breve descripción de la función.
- Si la función es demasiado larga es recomendable utilizar tag de html (ej:<ul><li>paso 1</li><li>paso 2</li></ul>) para ir describiendo paso a paso la función.
Importante
- El formato de la documentación de cada función empieza con /**
- Cada línea de contenido debe comenzar con un *
- Finalizar la documentación con */.
Generar la documentación
Una vez terminada la documentación de cada función y de todas las páginas php que necesita.
- Ir a la pestaña Window->Projects(Ctrl+1), donde nos listará todos los proyectos que tenemos en nuestro NetBeans.
- Hacer click derecho encima de nuestro proyecto el cuál hemos documentado y presionar en “Properties”, en la sección de “Categories” ir a “ApiGen”
- En “Target Directory” debemos indicar la carpeta en donde se generará nuestra documentación (es recomendable crear una carpeta nueva “documentación” dentro del mismo proyecto) y ok.
- Luego de hacer los pasos anteriores, volver hacer click derecho a nuestro proyecto y presionar “Generate Documentation”.
- NetBeans genera la documentación y la muestra en nuestro navegador por defecto, la url sería file:///var/www/nombre_proyecto/carpeta_documentación/index.html, aquí encontraremos la lista de todas las clases y sus funciones documentadas.