Monografiajavadoc

<html>
<head>
<body>
<title>monograf�a sobre java doc</title>
 <a name="universidad de panam�"></a>
<body bgcolor="009999">
 
universidad de panam� 
centro regional universitario de veraguas 

licenciatura en inform�tica para la gesti�n Educativa y empresarial 
trabajo de programaci�n 
monograf�a 
java doc 
profesor 
diego santimateo 
integrantes 
batista oradys 
9-721-869 
mendoza, maritza 
6-708-600 
poveda zuleyka 
9-724-1338 
fecha de entrega 
13/12/2006 
 <a href="#introducci�n">siguiente</a> 
 
 <a name="introducci�n"></a>
<marquee bgcolor="green" behavior="alternate" direction="right">monograf�a sobre java doc</marquee>
 introducci�n 

en esta monograf�a podr�s encontrar un contenido en el que se dan ciertas
definciones de java doc, a la
vez encontrar�s como debes documentar un c�digo, que tipo de comentarios deber�s
utilizar,cuando
documentar, y los delimitadores que debes utilizar. adem�s de lo antes mencionado
tambi�n encontrar�s
las opciones y las marcas de java doc. 
es por ello que surge la inquietud de saber: 
�que funcionalidad tiene java doc en la documentaci�n de nuestros c�digos?
a lo largo de esta investigaci�n podremos saber con seguridad la respuesta de este
planteamiento.
<a href="#universidad de panam�">atr�s</a> &nbsp &nbsp &nbsp &nbsp&nbsp &nbsp

&nbsp &nbsp<a href="#definici�n">siguiente</a>
 <a name="definici�n"></a>
definici�n 

definici�n: 
java doc es una herramienta de java que analiza los comentarios del c�digo fuente
y genera con
ello una colecci�n de htmls en donde se encuentra la descripci�n de las clases, la
estructura
jer�rquica, los m�todos de todas las clases y sus caracter�sticas. en otras
palabras javadoc
crea el api de tu programa java y lo estructura de forma similar al api de las
clases predefinidas de java.
documentar el c�digo de un programa es a�adir informaci�n para explicar lo que
hace un programa,
bien detallado, de forma que todo el que revise este c�digo entienda que hace el
c�digo y por
qu� lo hace. 
se puede decir que es una herramienta de documentaci�n enfocada a programas

realizados en el lenguaje java, la cual es
semiautom�tica al facilitar la generaci�n de un grupo de archivos html en base a
una sint�xis
de comentarios insertados en el c�digo fuente. es una herramienta del kit de
desarrollo que
permite generar documentaci�n Web a partir del c�digo, m�s que ayudar a comprender
el c�digo,
se centra en la interfaz (api-application programming interfaz) de las clases y
paquetes. javadoc
exige unos comentarios especiales.
 <a href="#introducci�n">atr�s</a> &nbsp &nbsp &nbsp &nbsp&nbsp &nbsp &nbsp
&nbsp<a href="#marco te�rico">siguiente</a>
 <a name="marco te�rico"></a>
marco te�rico 

como comentar c�digo 

como javadoc comprueba autom�ticamente clases, interfaces, m�todos y declaraciones
de variables,
se puede a�adir documentaci�n adicional a trav�s de comentarios de documentaci�n
en el c�digo
fuente. estos comentarios pueden incluir marcas html. un comentario de
documentaci�n est� formado
por todos los caracteres incluidos entre que indica el comienzo del comentario y
que indica el
final. en todas las l�neas intermedias los caracteres a la izquierda se ignoran,
y tambi�n todos
los espacios y tabuladores que precedan al car�cter (*).
 
tipos de comentarios: 
java cuenta con notaciones para introducir comentarios
 
entre estos tenemos:

 
comienzan con caracteres y se pueden prolongar a lo largo de varias l�neas,que
probablemente
comiencen con el car�cter y terminan con los caracteres.
 
-una l�nea
comienzan con los caracteres y terminan con la l�nea
 
cada tipo de comentario se debe adaptar a un prop�sito:
 
java doc se utiliza: 
-para generar documentaci�n externa.
 
-para documentar c�digo que no necesitamos que aparezca en la documentaci�n
externa (que genere javadoc).
este tipo de comentarios se usar� incluso cuando el comentario ocupe varias
l�neas.
 
componentes de java doc:
 
-api: com.sun.javadoc.
 
-aplicaci�n Javadoc.
 
delimitadores:
 
/** , */
 
qu� hay que documentar

 
reglas b�sicas:
 
-documentar es explicar aquello que no es evidente no repetir lo que se hace, sino
explicar
por qu� se hace as�.
 
es decir:
 
-�de qu� se encarga una clase? �un paquete?
 
-�qu� hace un m�todo?
 
-�cu�l es el uso esperado de un m�todo?
 
-�para qu� se usa una variable?
 
-�cu�l es el uso esperado de una variable?
 
-�qu� algoritmo estamos usando? �de d�nde lo hemos sacado?
 
-�qu� limitaciones tiene el algoritmo? �la implementaci�n?
 
-�qu� se deber�a mejorar si hubiera tiempo?
 
tipos de comentarios
 
-delimitados por �/**� y �*/�
 
-pueden abarcar varias l�neas (que quiz�s comiencen por �*�)
 
-permiten generar documentaci�n externa al programa.
 
-una l�nea comienzan con �//� y terminan con la l�nea.
 
-para documentar c�digo que no se desea que aparezca en documentaci�n externa.
 
 
cu�ndo documentar 
por obligaci�n (javadoc)
 
-al principio de cada clase
 
-al principio de cada m�todo
 
-antes de cada variable de clase
 
por conveniencia (una l�nea)
 
-al principio de un fragmento de c�digo no evidente
 
-a lo largo de los bucles
 
-por si acaso (una l�nea)
 
-siempre que se haga algo raro
 
-siempre que el c�digo no sea evidente
 
 <a href="#definici�n">atr�s</a> &nbsp &nbsp &nbsp &nbsp&nbsp &nbsp &nbsp

&nbsp<a href="#opciones de java doc">siguiente</a>
 <a name="opciones de java doc"></a>
opciones de java doc 

se puede utilizar un argumento que comience por el car�cter arroba, @ para indicar
que las opciones se encuentran en un fichero, cada argumento en una l�nea. estos
argumento
ser�n insertados autom�ticamente en la l�nea de comandos en la posici�n en que se
haya indicado
en el argumento @fichero.
javadoc ahora utiliza doclets para determinar su salida. si no se indica un doclet
espec�fico
a trav�s de la opci�n doclet, javadoc utilizar� el doclet est�ndar. javadoc
proporciona un
conjunto de opciones que se pueden utilizar con cualquier doclet y tambi�n
proporciona opciones adicionales a utilizar con el doclet est�ndar.
 
estas son las opciones de las que hablamos:
 
-doclet fichero 
especifica el fichero que contiene la configuraci�n del formato de salida que se
desea generar. si no se especifica, se generar� una salida con formato html
est�ndar.
 
-sourcepath path 
especifica el camino de b�squeda de los ficheros fuente .java. no afecta a la
carga de los ficheros de clases .class.
 
-classpath path 
no es conveniente utilizar esta opci�n, porque no es necesaria habitualmente; es
mejor utilizar -sourcepath para indicar donde se encuentran los ficheros .java a
documentar. especifica el camino que javadoc usa para encontrar los ficheros
.java. tambi�n indica los directorios desde los que javadoc carga sus propios
ficheros .class. sobreescribe el establecido por defecto o la variable de entorno
classpath si �sta ha sido establecida anteriormente. los directorios en la
variable classpath son separados con punto y coma (;).
 
-encoding nombre 
 
especifica el tipo de codificaci�n del fichero fuente, como eucjis\sjis. si no se
especifica, se usa en conversor de defecto de la plataforma.
 
-jflag 
pasa flag directamente al sistema operativo. por ejemplo, si es necesario que
limitemos la memoria utilizada por el sistema a 32 megabytes para generar la
documentaci�n, podr�amos utilizar este flag de la forma siguiente:
javadoc -j-xmx32m -j-xms32m &ltclasees>.
 
-package 
imprime paquetes y clases y miembros p�blicos y protected.
 
-private 
muestra todo tipo de clases y sus miembros.
 
-protected 
muestra solamente las clases p�blicas y protected y sus miembros. es la opci�n de
defecto.
 
-public 
muestra solamente clases y miembros p�blicos.
 
-verbose 
sin esta opci�n aparecen mensajes de carga de ficheros, generaci�n de
documentaci�n (un mensaje por fichero) y ordenaci�n.
con esta opci�n se muestran mensajes adicionales especificando el n�mero de
milisegundos empleado
en generar la documentaci�n de cada fichero java.
 <a href="#marco te�rico">atr�s</a> &nbsp &nbsp &nbsp &nbsp&nbsp &nbsp &nbsp
&nbsp<a href="#marcas de java doc">siguiente</a>
 <a name="marcas de java doc"></a>
marcas de java doc 

 
javadoc reconoce marcas especiales cuando recorre los comentarios de
documentaci�n. estas marcas
permiten autogenerar una documentaci�n completa y bien formateada del api a partir
del c�digo
fuente. las marcas comienzan siempre con el signo @. estas marcas deben situarse
al principio
de la l�nea (tener en cuenta que todo lo que haya hasta el primer car�cter * se
ignora) y
todas las marcas con el mismo nombre deben agruparse juntas dentro del comentario
de
documentaci�n.
 
marcas de documentaci�n de clases e interface
 
@see nombre_de_clase
 
a�ade un link a la clase en la zona "see also". por ejemplo:
 
@see java.lang.string
 
@see string
 
@see string#equals
 
@see java.lang.object#waint(int)
 
@see character#max_radix
 
@see <a hree="spec.html">especif. java</a>
 
el car�cter # separa el nombre de una clase del nombre de uno de sus campos,
m�todos o constructores. un comentario de documentaci�n puede incluir m�s de una
marca @see.
 
@version texto-version
 
a�ade una entrada "version". el texto no tiene que tener formato especial. un
comentario de documentaci�n puede incluir m�s de una marca @version.
 
@author texto-autor
 
a�ade una entrada "author". el texto no tiene que tener formato especial. un
comentario de documentaci�n puede incluir m�s de una marca @author.
 
@since texto
 
este texto no tiene una estructura especial. se utiliza para indicar desde qu�
fecha o desde qu� versi�n se ha introducido el cambio o caracter�stica que indica
el texto.
 
@deprecated texto
 
a�ade un comentario indicando que no deber�a utilizarse la funci�n o m�todo,
porque puede dejar de ser soportada por el api. la convenci�n que se sigue es
indicar en el texto la funci�n o m�todo por quien se ha sustituido. por ejemplo:
 
@deprecated replaced by setbounds(int,int,int,int)
 
si el miembro est� ya obsoleto y eliminado, el texto que sigue al tag.
 
@deprecated debe ser "no replacement".
 
marcas de documentaci�n de campos
 
la �nica marca especial que se puede incluir es la marca @see.
 
ejemplo de comentario de una clase:
/**
* coordenada x de la ventana
* @see window#1
*/
int x=1234567;
 
marcas de documentaci�n de constructores y m�todos
 
pueden ser marcas @see y adem�s:
 
@param par�metro descripci�n
 
a�ade un par�metro a la secci�n "parameters". la descripci�n puede continuar en la
l�nea siguiente.
 
@return descripci�n
 
a�ade una secci�n "return", que debe contener la descripci�n del valor de retorno.
 
@exception nombre_de_la_clase descripcion
 
a�ade una entrada "throws", que contiene el nombre de la excepci�n que puede ser
lanzada por el m�todo. la excepci�n estar� enlazada con su clase en la
documentaci�n.
 
@see nombre_de_clase
 
a�ade un link a la clase en la zona "see also".
 
@since texto
 
indica desde qu� fecha o desde qu� versi�n se ha introducido el cambio o
caracter�stica que indica el texto.
 
@deprecated texto
 
indica que no deber�a utilizarse la funci�n o m�todo, porque puede dejar de ser
soportada por el api.
 
ejemplo de comentario de un m�todo
 
/**
 
* devuelve el car�cter de la posici�n indicada entre
 
* <tt>0</tt> y <tt>length()-1</tt>
 
* @param indice la posici�n del car�cter a obtener
 
* @return el car�cter situado en la posici�n
 
* @exception stringindexoutofrangeexception
 
* se prodcue cuando el indice no est� en
 
* el rango <tt>0</tt> a <tt>length()-1</tt>
 
*/
 
public char charat( int indice ) {
 
. . .
}
 
 <a href="#opciones de java doc">atr�s</a> &nbsp &nbsp &nbsp &nbsp&nbsp &nbsp
&nbsp &nbsp<a href="#tabla">siguiente</a>
 <a name="tabla"></a>
tabla 
comentarios y etiquetas entendidas por javadoc /**

*/ 
<table width="80%" border="2" align="center" cellspacing="0" bordercolor="#000000"

border="50">
<tr>
<th bgcolor="99ccff">etiqueta</th><th bgcolor="99ccff">quien lo utiliza</th><th

bgcolor="99ccff">objetivo</th>
</tr>
<tr>
<td bgcolor="00cccc">a)@author name</td><td bgcolor="00cccc">clases e
interfaces</td><td bgcolor="00cccc">autor del c�digo. se pone una etiquetapara
cada autor.</td>
</tr>
<tr>
<td bgcolor="00cccc">b)-@deprecated</td> <td bgcolor="00cccc">clases, m�todos</td>
<td bgcolor="00cccc">m�todo anticuado. mejor no utilizarlo.</td>
</tr>
<tr>
<td bgcolor="00cccc">c)-@exception name description</td><td
bgcolor="00cccc">m�todos</td><td bgcolor="00cccc">excepciones que el m�todo
puedeelevar. se pone una etiqueta para cadaexcepci�n posible.</td>
</tr>
<tr>
<td bgcolor="00cccc">d)-@param name description</td><td
bgcolor="00cccc">m�todos</td><td bgcolor="00cccc">para describir los par�metros,
suutilizaci�n y su tipo. se pone unaetiqueta para cada par�metro.</td>
</tr>
<tr>
<td bgcolor="00cccc">e)-@return description</td><td
bgcolor="00cccc">m�todos</td><td bgcolor="00cccc">para describir los valores
devueltos porcada m�todo y su tipo.</td>
</tr>
<tr>
<td bgcolor="00cccc">f)-@since</td><td bgcolor="00cccc">clases, m�todos</td><td
bgcolor="00cccc">desde qu� versi�n est�. ej: desde.jdk 1.1</td>
</tr>
<tr>
<td bgcolor="00cccc">g)-@ see classname</td><td bgcolor="00cccc">clases,
interfaces,m�todos y atributos.</td><td bgcolor="00cccc">pondr� la direcci�n para
conectarsecon esta clase en la documentaci�n</td>
</tr>
<tr>
<td bgcolor="00cccc">h)-@see classname#nombrem�todo</td><td
bgcolor="00cccc">clases, interfaces,m�todos y atributos.</td><td
bgcolor="00cccc">pondr� la direcci�n para conectarsecon este m�todo en la
documentaci�n.</td>
</tr>
<tr>
<td bgcolor="00cccc">i)-@version text</td><td bgcolor="00cccc">clases,
interfaces.</td><td bgcolor="00cccc">informaci�n acerca de la versi�n.</td>
</tr>
</table>
 <a href="#marcas de java doc">atr�s</a> &nbsp &nbsp &nbsp &nbsp&nbsp &nbsp
&nbsp &nbsp<a href="#ejemplo">siguiente</a>
 <a name="ejemplo"></a>
ejemplo 
clase empresa 
// declaraci�n de paquetes que se debe importar 

import java.lang.string.*; 
import java.text.*; 
import javax.swing.*; 
// fin de la declaraci�n de paquetes que se debe importar 
/** 
* clase empresa 
* @version 1.0 13 de diciembre 2006 
* @author : oradys batista 
* @author : maritza mendoza 
* @author : poveda zuleyka 
* controla el salario de los empleados :aumenta 
* 
*/ 
public class empresa 
{ 
/** 
* m�todo p�blico est�tico: 
* utilizado para el llamado a los metodos 
* @paran un string utilizado
*/ 
public static void main(string [] args) 
{ 
string nomm,msg,s,sal,tiempo; 
int edd,ss,i,cod,j; 
float sall,cap,bono; 
int[] codigos=new int[10]; 
capturar cat=new capturar(); 
i=0; 
do 
{ 
msg="introduce el nombre del ejecutivo"; 
nomm=cat.captura(msg); 
msg="introduzca su edad"; 
edd=integer.parseint(cat.captura(msg)); 
msg="introduzca su salario"; 
sal=cat.captura(msg); 
sall=float.parsefloat(sal); 
msg="introduzca el capital de la empresa"; 
sal=cat.captura(msg); 
cap=float.parsefloat(sal); 
//se crea instancia de la clase empleado 
empleado dato=new empleado(nomm,edd,sall); 
tiempo="10 a�os 14 dias"; 
bono=10; 
dato.aumentoejecutivo(bono); 
string mm=dato.informecodigo(tiempo); 
system.out.println("codigo: "+mm); 
s=joptionpane.showinputdialog(null,"si desea continuar preciona 0:"); 

ss=integer.parseint(s); 
i++; 
}while(ss==0); 
system.out.println("**************codido de empresas
visitadas************"); 
system.exit(0); 
} 
} 
clase empleado 
import java.lang.string.*; 
import javax.swing.*; 
/** 
* clase empleado 
* @version 1.0 13 de diciembre 2006 
* @author oradys batista 
* @author maritza mendoza 
* @author poveda zuleyka 
* controla el salario de los empleados para el posterior aumento del mismo 
* y una bonificacion navide�a. 
*/ 
public class empleado { 
// declaraci�n de variables de clase 
/** 
* atributos privados: 
* representa el nombre del empleado 
*/ 
private string nombre; 
/** 
* atributo publicos: 
* representa la edad del empleado 
*/ 
public int edad; 

/** 
* atributos publico: 
* representa el salario del empleado 
*/ 
public float salario; 

/** 
* constructor p�blico: 
* utilizado para asignar valor a las variables privadas 
*/ 
public empleado(string nombr,int eda,float salari) 
{ 
nombre=nombr; 
edad=eda; 
salario=salari; 
} 
/** m�todo p�blico: 
* utilizado para obtener el nombre del empleado. 
* @return un string que representa el nombre del empleado. 
*/ 
public string getnombre() 

{ 
return nombre; 
} 
* utilizado para obtener la edad del empleado. 
* @return un entero que representa la edad del empleado. 
*/ 
public int getedad() 
{ 
return edad; 
} 
/**m�todo p�blico: 
* utilizado para obtener el salario del empleado. 
* @return un float que representa el salario del empleado. 
*/ 
public float getsalario() 
{ 
return salario; 
} 

* utilizado para obtener el aumento del salario del empleado . 
* @param bon : es el float que representa el bono navideno. 
* @return un float que representa el salario aumentado del empleado. 
*/ 
public float aumentoejecutivo(float bon) 
{ 
if(salario>300.00 ) 
{ 
salario=salario+50+bon; 
return(salario); 
} 
else 
{ 
salario=salario+bon; 
return(salario); 
} 
} 
* utilizado para obtener el aumento del salario del empleado . 
* @param tiem : es el string que representa el tiempo de prestar
servicio. 
* @return un string que representa el codigo y tiempo de servicio del
empleado. 
*/ 
public string informecodigo(string tiem) 
{ 
string s,tiemcodi; 
int cod; 
s=joptionpane.showinputdialog(null,"indique su codigo:"); 
cod=integer.parseint(s); 
tiemcodi=" "+cod+"tu tiempo de servicio es de:"+" "+tiem +"\n "+"gracias por
su servicio"; 
return(tiemcodi); 
} 
} 
 <a href="#tabla">atr�s</a> &nbsp &nbsp &nbsp &nbsp&nbsp &nbsp &nbsp &nbsp<a
href="#glosario">siguiente</a>
 <a name="glosario"></a>
glosario 
1. javadoc: es una herramienta de java para generar documentaci�n b�sica para

el
programador a partir del c�digo fuente. 
2. c�digo: es una aplicaci�n elaborada para la soluci�n de un determinado

programa. 
3. documentar: documentar el c�digo de un programa es a�adir suficiente

informaci�n
como para explicar lo que hace, punto por punto. 
4. comentario: la documentaci�n Java doc est� formada por todos los caracteres
incluidos entre (/*,*/) (/**,*/) (//), que indican el comienzo del comentario y
que indican el final.
en otras palabras aclaraci�n que el programador incluye en el texto del programa
para mejorar su inteligibilidad. 
5. delimitadores: s�mbolos utilizados como separadores de las distintas

construcciones
de lenguaje de programaci�n (esto es, los signos de puntuaci�n de un lenguaje de
programaci�n) 
6. identificadores: palabra que podemos utilizar para denominar algo en el

lenguaje. 
7. operadores: realizan acciones especificas. 
8. interfaz: contiene una colecci�n de m�todos que se implementan en otro

lugar.
los m�todos de una clase son public, static y final. 
9. marcas de javadoc: permiten autogenerar una documentaci�n completa y bien

formateada
del api a partir del c�digo fuente. las marcas comienzan siempre con el signo de
@. 
10. opciones de javadoc: especifican el fichero de la configuraci�n del

formato de
salida que se desea generar. si no se especifica, se generar� una salida con
formato html
est�ndar(doclet fichero), y otros. 
 <a href="#ejemplo">atr�s</a> &nbsp &nbsp &nbsp &nbsp&nbsp &nbsp &nbsp &nbsp<a
href="#experiencias">siguiente</a>
 <a name="experiencias"></a>
experiencias 
oradys batista: 
la realizaci�n de este proyecto ha sido considero muy enriquecedor para mi, ya
que es
indispensable para los programadores la documentaci�n de c�digo, y es en ello en
que se
ha basado esta monograf�a de javadoc. durante la realizaci�n de la monograf�a nos
fue
necesaria las consultas al facilitador y claro mucha preocupaci�n ya que por mi
parte
contaba con la informaci�n pero no savia como aplicarla en el caso del ejemplo
documentado,
pero lo mas importante fue la comprensi�n del tema y de esta manera se logro el
objetivo
propuesto. al usar javadoc me siento con mucho mas segura para elaborar c�digos en
java
porque puedo documentar mi programas y en un futura hacer modificaciones donde me
sea
necesario debido a que cuento con una documentaci�n que me especifica que hace
cada m�todo,
clase ,cuales son los argumento, que retorna cada m�todo etc. 
maritza mendoza: 
considero que esta monograf�a ha sido muy interesante ya que me permiti�
adquirir nuevos conocimientos, java doc es una excelente herramienta la cual
nos ayuda a hacer los c�digos muchos m�s entendibles, y se hace m�s sencillo
viajar
a trav�s del c�digo, sobre todo cuanto estos son lo bastantes extensos, logre
comprender la
funcionalidad que tienen etiquetas como @return que se encarga de indicar lo que
me devuelve un m�todo, y @param que se encarga de ver los parametros que recibe un
m�todo. considero que fue muy importante para mi aplicarle java doc al c�digo
antes explicado
ya que se logro comprender mucho m�s la funcionalidad que tiene java doc para la
documentaci�n de
los c�digos.
 
zuleyka poveda: 
durante la realizaci�n de esta monograf�a obtuve una experiencia gratificante
ya que el esfuerzo y las noches de desvelo que le dedique al trabajo valieron la
pena,
ya que hoy d�a puedo decir con mayor seguridad en que consiste javadoc, como se
documenta
un c�digo en javadoc utilizando las etiquetas necesarias y en el lugar apropiado.
considero que fue un trabajo muy enriquecedor porque era un tema que desconoc�a
por completo
no sabia lo gran importante que es documentar los c�digos en javadoc y lo censillo
que es pienso
que los objetivos previstos se lograron.
 <a href="#glosario">atr�s</a> &nbsp &nbsp &nbsp &nbsp&nbsp &nbsp &nbsp &nbsp<a
href="#conclusiones">siguiente</a>
 <a name="conclusiones"></a>
conclusiones 
despues de haber realizado esta investigaci�n podemos llegar a las siguientes

conclusiones: 
- que java doc es una excelente herramienta de java que permite visualizar y
analizar los comentarios
del c�digo fuente que uno a elaborado y genera un codigo de htmls debidamente
documentado en base
a una sint�xis de comentarios insertados en el c�digo fuente, que nos dejaran ver
la descripci�n de
las clases, los m�todos, etc. 
- tambi�n comprendimos que es muy importante documentar al principio de cada

clase, al inicio de cada m�todo
y antes de cada variable de una clase. 
- muy importante es mencionar que se debe documentar lo que no es evidente y

explicar el
por qu� se hace as�. 
- podemos decir que java doc cuenta con etiquetas como "@author diego" la etiqueta
es @author
y tu puedes colocar tu nombre que ser� el indicativo de que ese codigo es de tu
autoria, adem�s
como ya lo viste anteriormente en el ejemplo, puedes aplicar la versi�n de tu
c�digo con @version,
es decir 1.0 si es tu primer c�digo y si le hiciste alguna modificaci�n ser�a la
1.2. 
- otras etiquetas importantes que tienen una excelente funcionalidad y que

esperamos no se te olvide
despues de visitar esta p�gina son: 
-@param indican los parametros que recibe un m�todo 
-@return indican lo que retorna un m�todo 
 <a href="#experiencias">atr�s</a> &nbsp &nbsp &nbsp &nbsp&nbsp &nbsp &nbsp

&nbsp<a href="#recomendaciones">siguiente</a>
 <a name="recomendaciones"></a>
recomendaciones 
recomendamos la utilizaci�n de esta herramienta por las siguientes

razones: 
- ayuda a una mayor comprensi�n del c�digo. 
- se pueden realizar modificaciones de una manera mas r�pida, ya que puedes

encontra
la parte de c�digo donde quieres hacer los cambios ya que todo esta documentado y
si no fuera as�
tendr�as que visitar l�nea por l�nea para lograr lo que quieres hacer. 
- ahorro de tiempo cuando programas. 
- disminuye el riesgo de cometer errores fatales que se pueden convertir en un

gran problema
cuando el c�digo se va extendiendo. 
 <a href="#conclusiones">atr�s</a> &nbsp &nbsp &nbsp &nbsp&nbsp &nbsp &nbsp

&nbsp<a href="#bibliograf�a">siguiente</a>
 <a name="bibliograf�a"></a>
bibliograf�a 
bibliografias sobre monograf�as 
<a href="
http://www.todacultura.com/monografias.htm">www.todacultura.com/monografias.htm</a
> 
<a href="
http://www.geocities.com/enriquearamburu/ete/guia.html">www.geocities.com/enriquea
ramburu/ete/guia.html</a> 
<a href="
http://www.monografias.com/trabajos7/mono/mono.shtml">www.monografias.com/trabajos
7/mono/mono.shtml</a> 
<a href="
http://www.educar.org/lengua/monografia/index.asp">www.educar.org/lengua/monografi
a/index.asp</a> 
bibliografias sobre java doc 

<a href="
http://www.iua.upf.es/~hsolis/piii/sesion09.html">www.iua.upf.es/~hsolis/piii/sesi
on09.html</a> 
<a href="
http://www.lab.dit.upm.es/~lprg/material/apuntes/doc/doc.htm">www.lab.dit.upm.es/~
lprg/material/apuntes/doc/doc.htm</a> 
<a href="
http://www.miliuco.net/java/javadoc.htm">www.miliuco.net/java/javadoc.htm</a> 
 <a href="#recomendaciones">atr�s</a>


</head>
</body>
</html>

Monografiajavadoc

Diunggah oleh

Informasi Dokumen

Judul Asli

Hak Cipta

Format Tersedia

Bagikan dokumen Ini

Bagikan atau Tanam Dokumen

Opsi Berbagi

Apakah menurut Anda dokumen ini bermanfaat?

Apakah konten ini tidak pantas?

Hak Cipta:

Format Tersedia

Monografiajavadoc

Diunggah oleh

Hak Cipta:

Format Tersedia

<html>

<title>monograf�a sobre java doc</title>

<p> <a name="universidad de panam�"></a></p>

<p align="center"> <font color="white" size="4">

universidad de panam� <br>

centro regional universitario de veraguas <br>

<p> <a href="#introducci�n">siguiente</a> </p>

<p> <a name="introducci�n"></a></p>

<marquee bgcolor="green" behavior="alternate" direction="right"><b><font

<p align="center"> introducci�n<br><br><br></p>

<p><a href="#universidad de panam�">atr�s</a> &nbsp &nbsp &nbsp &nbsp&nbsp &nbsp

<p> <a name="definici�n"></a></p>

se puede decir que es una herramienta de documentaci�n enfocada a programas

<p> <a name="marco te�rico"></a></p>

<p align="center">marco te�rico<br><br><br></p>

como comentar c�digo<br>

entre estos tenemos:

qu� hay que documentar

<p> <a href="#definici�n">atr�s</a> &nbsp &nbsp &nbsp &nbsp&nbsp &nbsp &nbsp

<p> <a name="opciones de java doc"></a></p>

<p align="center">opciones de java doc<br><br><br></p>

<p> <a name="marcas de java doc"></a></p>

<p align="center">marcas de java doc<br><br><br></p>

<p> <a name="tabla"></a></p>

<p align="center">comentarios y etiquetas entendidas por javadoc /**

<table width="80%" border="2" align="center" cellspacing="0" bordercolor="#000000"

<th bgcolor="99ccff">etiqueta</th><th bgcolor="99ccff">quien lo utiliza</th><th

<p> <a name="ejemplo"></a></p>

// declaraci�n de paquetes que se debe importar<br>

s=joptionpane.showinputdialog(null,"si desea continuar preciona 0:");<br>

public int edad;<br>

public float salario;<br>

public string getnombre()<br>

/** m�todo p�blico:<br>

<p> <a name="glosario"></a></p>

1. javadoc:<br> es una herramienta de java para generar documentaci�n b�sica para

2. c�digo:<br> es una aplicaci�n elaborada para la soluci�n de un determinado

3. documentar:<br> documentar el c�digo de un programa es a�adir suficiente

5. delimitadores:<br> s�mbolos utilizados como separadores de las distintas

6. identificadores:<br> palabra que podemos utilizar para denominar algo en el

7. operadores:<br> realizan acciones especificas.<br><br>

8. interfaz:<br> contiene una colecci�n de m�todos que se implementan en otro

9. marcas de javadoc:<br> permiten autogenerar una documentaci�n completa y bien

10. opciones de javadoc:<br> especifican el fichero de la configuraci�n del

<p> <a name="experiencias"></a></p>

despues de haber realizado esta investigaci�n podemos llegar a las siguientes

- tambi�n comprendimos que es muy importante documentar al principio de cada

- muy importante es mencionar que se debe documentar lo que no es evidente y

- otras etiquetas importantes que tienen una excelente funcionalidad y que

<p> <a href="#experiencias">atr�s</a> &nbsp &nbsp &nbsp &nbsp&nbsp &nbsp &nbsp

<p> <a name="recomendaciones"></a></p>

recomendamos la utilizaci�n de esta herramienta por las siguientes

- se pueden realizar modificaciones de una manera mas r�pida, ya que puedes

- ahorro de tiempo cuando programas.<br><br>

- disminuye el riesgo de cometer errores fatales que se pueden convertir en un

<p> <a href="#conclusiones">atr�s</a> &nbsp &nbsp &nbsp &nbsp&nbsp &nbsp &nbsp

<p> <a name="bibliograf�a"></a></p>

bibliografias sobre monograf�as <br><br>

bibliografias sobre java doc<br><br>

<p> <a href="#recomendaciones">atr�s</a></p>

Anda mungkin juga menyukai