Cómo documentar un Proyecto en PHP con NetBeans - Revision history

Alex: /* Usando Terminal para ApiGen 4+ */

2015-06-02T15:40:17Z

Usando Terminal para ApiGen 4+

← Older revision		Revision as of 15:40, 2 June 2015
Line 107:		Line 107:
	Con NetBeans 8 o previo no se puede generar la documentación usando ApiGen 4+ ya que cambia la forma como se genera la documentación. Para generar la documentación hay que hacerlo como comando desde la línea de comando, de la siguiente manera:		Con NetBeans 8 o previo no se puede generar la documentación usando ApiGen 4+ ya que cambia la forma como se genera la documentación. Para generar la documentación hay que hacerlo como comando desde la línea de comando, de la siguiente manera:
	<source lang="bash">		<source lang="bash">
	apigen~~.phar~~ generate --source [directorio a documentar] --destination [directorio de destino]		apigen generate --source [directorio a documentar] --destination [directorio de destino]
	</source>		</source>

Felipe: Felipe moved page Como documentar un Proyecto en PHP con NetBeans to Cómo documentar un Proyecto en PHP con NetBeans: Error gramatical

2015-02-12T16:07:17Z

Felipe moved page Como documentar un Proyecto en PHP con NetBeans to Cómo documentar un Proyecto en PHP con NetBeans: Error gramatical

← Older revision	Revision as of 16:07, 12 February 2015
(No difference)

Felipe: /* Comenzar a documentar */

2015-02-11T19:01:47Z

Comenzar a documentar

← Older revision		Revision as of 19:01, 11 February 2015
Line 16:		Line 16:
	- ApiGen Script: '''/usr/local/netbeans-7.3/apigen/apigen.php'''		- ApiGen Script: '''/usr/local/netbeans-7.3/apigen/apigen.php'''

	== ~~Comenzar a documentar~~ ==		==Cómo Documentar==

Felipe: /* Configuración Netbeans */

2015-02-11T19:00:45Z

Configuración Netbeans

← Older revision		Revision as of 19:00, 11 February 2015
Line 1:		Line 1:
			==Instalación==
			Estas instrucciones aplican para ApiGen 4+.

			# Descargar código de http://www.apigen.org.
			# Guardarlo en un directorio, se sugiere en OS X en /usr/local/apigen.
			# Volver ejecutable el archivo descargado.
			# Agregar el archivo al PATH para ser usado desde cualquier parte. <source lang="bash">sudo ln -s /usr/local/apigen/apigen.phar /usr/local/bin/apigen</source>

	== Configuración Netbeans ==		== Configuración Netbeans ==
			'''Nota''': Esta forma no aplica con ApiGen 4+.

	Ingresar a la pestaña Profile -> Options.		Ingresar a la pestaña Profile -> Options.

Felipe: /* Generar la documentación */

2015-02-11T18:55:25Z

Generar la documentación

← Older revision		Revision as of 18:55, 11 February 2015
Line 83:		Line 83:
	#Finalizar la documentación con */.		#Finalizar la documentación con */.

	== Generar la documentación ==		==Generar la documentación==

			===Usando NetBeans===

	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.
Line 91:		Line 93:
	# Luego de hacer los pasos anteriores, volver hacer click derecho a nuestro proyecto y presionar '''“Generate Documentation”'''.		# 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.		# 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.

			===Usando Terminal para ApiGen 4+===

			Con NetBeans 8 o previo no se puede generar la documentación usando ApiGen 4+ ya que cambia la forma como se genera la documentación. Para generar la documentación hay que hacerlo como comando desde la línea de comando, de la siguiente manera:
			<source lang="bash">
			apigen.phar generate --source [directorio a documentar] --destination [directorio de destino]
			</source>

Felipe: /* Ejemplo */

2014-03-26T16:01:29Z

Ejemplo

← Older revision		Revision as of 16:01, 26 March 2014
Line 30:		Line 30:
	class variableStruct {		class variableStruct {

	/** @var string nombre ~~y valor de los parámetros~~. */		/** @var string nombre del parámetro. */
	public $name;		public $name;

			/** @var string valor del parámetro. */
	public $value;		public $value;
	}		}

Alex: /* Para las Clases */

2014-03-26T15:36:23Z

Para las Clases

← Older revision		Revision as of 15:36, 26 March 2014
Line 14:		Line 14:
	#En la línea anterior de cada clase escribir /**.		#En la línea anterior de cada clase escribir /**.
	#En la siguiente línea poner * una breve descripción de la clase		#En la siguiente línea poner * una breve descripción de la clase
			##Si es necesario una descripción mas extensa de la clase, hacer un salto de línea y escribir.
	#La tercer línea terminar la documentación con un */.		#La tercer línea terminar la documentación con un */.
			#En la línea anterior a los parámetros, escribir /**.
			#Se creará el parámetro, especificar tipo y describir función.
			#Terminar con un */.

	==== Ejemplo ====		==== Ejemplo ====
Line 21:		Line 25:
	/**		/**
	* Esta clase es una estructura necesaria para interactuar con ProcessMaker		* Esta clase es una estructura necesaria para interactuar con ProcessMaker
			*
			* Descripción extensa.
	*/		*/
	class variableStruct {		class variableStruct {

Alex: /* Ejemplo */

2014-03-26T15:26:59Z

Ejemplo

← Older revision		Revision as of 15:26, 26 March 2014
Line 24:		Line 24:
	class variableStruct {		class variableStruct {

			/** @var string nombre y valor de los parámetros. */
	public $name;		public $name;
	public $value;		public $value;

Alex: /* Ejemplo */

2014-03-26T15:20:54Z

Ejemplo

← Older revision		Revision as of 15:20, 26 March 2014
Line 53:		Line 53:
	* @author nombre apellido <correo>		* @author nombre apellido <correo>
	*		*
	* @param string ~~$idCaso~~ APP_UID del caso.		* @param string APP_UID del caso.
	* @param int ~~$delIndex~~ DEL_INDEX del caso.		* @param int DEL_INDEX del caso.
	* @param string ~~$idOldUser~~ USR_UID del usuario ya asignado.		* @param string USR_UID del usuario ya asignado.
	* @param string ~~$idNewUser~~ USR_UID del nuevo usuario a asignar.		* @param string USR_UID del nuevo usuario a asignar.
	*/		*/
	public function reasignarCaso($idCaso, $delIndex, $idOldUser, $idNewUser) {		public function reasignarCaso($idCaso, $delIndex, $idOldUser, $idNewUser) {

Alex: /* Ejemplo */

2014-03-26T13:51:16Z

Ejemplo

← Older revision		Revision as of 13:51, 26 March 2014
Line 17:		Line 17:

	==== Ejemplo ====		==== Ejemplo ====
			Esto es solo una calse de ejemplo, para mostrar el formato de documentación.
	<syntaxhighlight lang="php">		<syntaxhighlight lang="php">
	/**		/**