Monografía JavaDoc

<!doctype html public "-//w3c//dtd html 4.
01 transitional//en"
"http://www.w3.org/tr/html4/loose.dtd">
<html>
<head>
<title>javadoc</title>
<meta http-equiv="content-type" content="text/html; charset=iso-8859-1">
<style type="text/css">

</style>
</head>
<body>
<table width="990" border="0" cellpadding="0" cellspacing="0" bgcolor="#ffffff">

<tr>
<td width="990" height="105" valign="top"><table width="100%" border="0"
cellpadding="0" cellspacing="0" bgcolor="#0080c0">
<tr>
<td width="990" height="105" valign="top"><div align="right">
<h2 class="estilo1">universidad de panamá 
centro regional de veraguas 
facultad de informática, electrónica y comunicaciones
 
licenciatura en ingeniería en informática </h2>
</div></td>
</tr>
</table></td>
</tr>
<tr>
<td height="48" valign="top"><table width="100%" border="0" cellpadding="0"
cellspacing="0">
<tr>
<td width="990" height="48" valign="top" bgcolor="#c0c0c0"> </td>
</tr>
</table></td>
</tr>
<tr>
<td height="269" valign="top"><div align="center">
<table width="100%" border="0" cellpadding="0" cellspacing="0">
<tr>
<td width="990" height="269" valign="top"> 
__________________________________________________________________________________
___________________ 
<h2 class="estilo2 estilo3"> javadoc como herramienta para
la documentacion de programas en java</h2>
__________________________________________________________________
___________________________________
carlos de gracia
fátima hernández 
__________________________________________________________________
__________________________________________________________ índice<a name="indice"></a>
 <ul>
<li>
<div align="left"><a href="#intro">introducci�n</a></div>
</li>
<li>
<div align="left"><a href="#general">generalidades</a></div>
</li>
<li>
<div align="left"><a href="#teor">fundamentacion
teorica</a></div>
</li>
<li>
<div align="left"><a href="#exper">experimentaci�n</a></div>
</li>
<li>
<div align="left"><a href="#resul">resultados</a></div>
</li>
<li>
<div align="left"><a href="#discu">discusi�n</a></div>
</li>
<li>
<div align="left"><a href="#refer">referencias
electronicas</a></div>
</li>
<li>
<div align="left"><a href="#anex">anexos </a></div>
</li>
</ul>
 
 
_________________________________________________________*********_____________
_____________________________________________
introducción<a
name="intro"></a>
 
 javadoc es una herramienta de java para generar
documentación básica para el programador a partir del código
fuente. la herramienta javadoc analiza los comentarios del código fuente y
genera con ello una documentación en formato html, 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. la transformación de código fuente a formato html
la realiza utilizando un mecanismo extensible llamado doclet. un doclet es una
clase que es llamada por el programa javadoc para que genere la
documentación.
 el presente trabajo forma parte de una
investigación en donde se pretende conocer los aspectos que involucran la
implementación de la herramienta javadoc. aquí se presentará
una percepción sobre la implementación de esta tecnología y
la importancia de la misma para incrementar la calidad de los programas basados en
el lenguaje de programación java.
 los ejes a abordar en esta investigación
son los siguientes: en un primer capitulo analizaremos las generalidades de esta
investigación; seguidamente se presenta el segundo capitulo en donde se
presenta toda la fundamentacion teórica referente al tema de
investigación. 
como tercera parte se presentará la experimentación
que hace referencia a la implementación de la herramienta javadoc,
así como los respectivos resultados obtenidos. en una parte final se
presentarán las conclusiones que se formularán con el desarrollo del
tema en estudio, así como las respectivas recomendaciones que
servirán de apoyo para la mejora del tema en investigación. 
 estos ejes se corresponden con algunos aportes y
ejemplos presentados.
<a href="#indice">�ndice</a>
 
i. generalidades<a
name="general"></a>
 
1.1. estado del problema
documentar el código de un programa es
añadir suficiente información como para explicar lo que hace, punto
por punto, de forma que todos entiendan qué están haciendo y por
qué. 
documentar un programa es una necesidad que sólo se aprecia en su
debida magnitud cuando hay errores que reparar o hay que extender el programa con
nuevas capacidades o adaptarlo a un nuevo escenario. 
la investigación e implementación de la herramienta javadoc en
los programas ha permitido responder a interrogantes como lo son : 
¿de qué se encarga una clase? 
¿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? 
1.2. objetivos
entre los objetivos de esta investigación,
podemos enunciar los siguientes:
<div align="justify">
<ul>
<li> orientar la investigación hacia la
consecución de metas. </li>
<li>conocer el funcionamiento y aplicación de la
herramienta javadoc.</li>
<li> determinar los beneficios que se pueden obtener con la
implementación de la herramienta javadoc.</li>
</ul>
1.3. alcance
 el trabajo presentado a continuación es un estudio
sobre la herramienta para la documentacion de programas en java, javadoc, que
abarca desde la definición de sus conceptos hasta su aplicación en
un ejemplo práctico, en el mismo veremos como esta poderosa herramienta nos
permite generar la correspondiente documentacion para nuestas aplicaciones. 
 este trabajo contiene la siguiente documentacion:
<ul>
<li> que es javadoc</li>
<li>elementos de comportamiento</li>
</ul>
1.4. metodología 
el tipo de estudio de investigación es descriptivo, ya
que el tema se centra en describir como se implementa javadoc en la generacion de
documentacion de programas.
 en esta etapa se realizarán consultas
bibliográficas relacionadas con el análisis e implementacion de esta
herramienta, con el fin de obtener los resultados previstos. 
 

</div> <a
href="#indice">�ndice</a>
ii. fundamentación
teórica<a name="teor"></a>
2.1. javadoc
el paquete de desarrollo java incluye una
herramienta de software, javadoc, para generar la documentación del api, en
formato html, del código fuente de java. 
la mayoría de los entornos de desarrollo integrados generan
automáticamente la documentación en formato html. javadoc
también proporciona un api para crear doclets y taglets, que permite que
analices la estructura de una aplicación java. 
esta herramienta toma en consideración
algunos comentarios para generar una documentación bien presentada de
clases y componentes de clases (variables y métodos).
se dice que javadoc se centra en la interfaz (api
- application programming interface) de las clases y paquetes java.
javadoc realza algunos comentarios, de los que
exige una sintaxis especial. deben comenzar por "/**" y terminar por
"*/", incluyendo una descripción y algunas etiquetas
especiales:
 
/** 
* parte descriptiva. 
* que puede consistir de varias frases o párrafos. 
* 
* @etiqueta texto específico de la etiqueta 
*/ estos comentarios especiales
deben aparecer justo antes de la declaración de una clase, un atributo o un
método en el mismo código fuente. en las siguientes secciones se
detallan las etiquetas (tags) que javadoc sabe interpretar en cada uno de los
casos. 
como regla general, hay que destacar que la primera frase (el
texto hasta el primer punto) recibirá un tratamiento detacado, por lo que
debe aportar una explicación concisa y contundente del elemento
documentado. las demás frases entrarán en detalles. 
2.2. documentación
<blockquote>
</blockquote>
</div> <blockquote>2.2.1. clases e
interfaces 
deben usarse al menos las etiquetas:
<ul>
<li>@autor</li>
<li>@version</li>
</ul>
</div>
a continuacion se muestran todas las etiquetas y su
interpretación:
<ul>
<li> @autor nombre del autor</li>
<li> @versión identificación de la versión y
fecha </li>
<li> @see referencia a otras clases y métodos</li>
<li> @since indica desde qué versión o fecha existe
esta clase o interfaz en el paquete</li>
<li>@deprecated esta clase no debería usarse pues puede
desaparecer en próximas versiones </li>
</ul>
<blockquote>
veámos un ejemplo del comentario de una clase:
/** 
* a class representing a window on the screen. 
* for example: 
* <pre> 
* window win = new window(parent); 
* win.show(); 
* </pre> 
* 
* @author sami shaio 
* @version %i%, %g% 
* @see java.awt.basewindow 
* @see java.awt.button 
*/ 
class window extends basewindow { 
... 
}
</blockquote>
</div>
2.2.2. constructores y métodos
deben usarse al menos las etiquetas
<ul>
<li> @param: una por argumento de entrada</li>
<li> @return: si el método no es void</li>
<li> @exception: una por tipo de exception que se puede
lanzar</li>
</ul>
</div>
a continuacion se muestran todas las etiquetas y su
interpretación
<ul>
<li>@param : nombre del parámetro - descripción de
su significado y uso </li>
<li>@return : descripción de lo que se devuelve </li>
<li>@exception : nombre de la excepción - excepciones que
pueden lanzarse </li>
<li>@since : indica desde qué versión o fecha existe
este constructor o método en la clase </li>
<li>@deprecated : este método no debería usarse pues
puede desaparecer en proximas versiones </li>
</ul>
un ejemplo:
* returns the character at the specified index. an index 
* ranges from <code>0</code> to <code>length() -
1</code>. 
* 
* @param index the index of the desired character. 
* @return the desired character. 
* @exception stringindexoutofrangeexception if the index is not in
the 
range <code>0</code> 
* to <code>length()-1</code>. 
* @see java.lang.character#charvalue() 
*/ 
public char charat(int index) { 
...
}
2.2.3. comentario de variables
las etiquetas que podemos utilizar en esta ocasión son:
<ul>
<li>@see</li>
<li>{@link</li>
<li>@since</li>
<li>@deprecated</li>
<li>@serial</li>
<li>@serialfield</li>
</ul>
un ejemplo:
* the x-coordinate of the component. 
* 
* @see #getlocation() 
*/ 
int x = 1263732;
</div>
<blockquote> 
</blockquote>
</blockquote>
iii. experimentación<a
name="exper"></a>
en esta fase presentaremos un ejemplo que consiste en
la experimentacion de un ejemplo al cual le aplicamos la herramienta javadoc el
cual nos permitirá generar la respectiva documentacion referente al codigo
del programa.
para ejecutar el archivo puede acceder a la siguiente
direccion en donde se encuentra el archivo ejecutable java <a
href="http://esnips.com/web/monografiajavadoc
">http://esnips.com/web/monografiajavadoc </a>
el nombre del archivo es : fase de experimentacion
y resultados 
 
<a href="#indice">�ndice </a>
iv. resultados<a
name="resul"></a>
4.1. presentacion de resultados
a continuación se presentan los resultados
obtenidos de los ejemplos presentados.
para acceder a la documentacion generada por la
herramienta javadoc acceda al siguiente enlace: <a
href="http://esnips.com/web/monografiajavadoc">http://esnips.com/web/monografiajav
adoc</a> 
el nombre del archivo es empresa.java
 
v. discusión<a
name="discu"></a>
5.1. conclusiones 
como conclusion podemos decir que que este tipo de
investigaciones orientan al estudiante a conocer nuevas metodologias y
herramientas referentes a la programacion, con lo que se adquiere un gardo de
conocimiento mas desarrollado, dependiendo del empeño y esfurzo que se
imponga en el trabajo.
la elaboracion de este trabajo nos ha incitado a
profundizar mucho mas en el estudio de este lenguaje, ya que es muy amplio, y
exije un esfurzo muy grande, para adquirir todo el conocimiento referente a la
programacion java. 
5.2. recomendaciones
entre las recomendaciones que podemos mencionar
tenemos:
<ul>
<li>que siempre que se diseñe una aplicacion java , seria
de muy buena practica, utilizar esta herramienta javadoc, ya que nos da una
ventaja a la hora de generar la documentacion de nuestro codigo.</li>
<li>tambien podriamos decir que se recomienda ampliar la
fase investigativa y de analisis de este trabajo, ya que la aplicacion de este
tipo de herramientas rquieren un estudi mas extenso. </li>
</ul>
</div> <ul>
</ul> <ul>
</ul> <ul>
</ul> 
 
<a href="#indice">�nicio</a>
vi. referencia electronica<a
name="refer"></a>
documentacion javadoc
excelente pagina que contiene un detallado manual con
informacion referente a la generacion de documentacion de los programas java,
utilizando la herramienta javadoc. en esta pagina se decribe paso a paso todo el
procedimiento de generacion de documentacion. 
documentacion con javadoc [en linea] : adictos al
trabajo.<a
href="http://www.adictosaltrabajo.com/tutoriales/tutoriales.php?pagina=javadoc">ht
tp://www.adictosaltrabajo.com/tutoriales/tutoriales.php?pagina=javadoc</a> [12
diciembre 2006] .
javadoc tool
muy buena pagina de los creadores de java, sun
microsystem. contiene mucha informacion y enlaces ,con respecto a la herramienta
javadoc. en esta pagina podemos encontrar informacion sobre las especificaciones
para escribir comentarios en java, asi como la implementacion de esta herramienta.
se las recomiendo ya que es muy interesante, su unico inconveniente es que solo se
encuentra en ingles. 
javadoc tool [en linea]. sun developer network. <a
href="http://java.sun.com/j2se/javadoc/">http://java.sun.com/j2se/javadoc/</a>
 . [12 diciembre 2006] 
 
<a href="#indice">�nicio</a>
vii. anexos<a
name="anex"></a>
glosario
javadoc:
javadoc es una herramienta integrada al sdk de java, que permite documentar de

manera rápida y sencilla las clases y los métodos que se proveen.

fichero:
es un conjunto de información que se almacena para consultarse o

utilizarse posteriormente. 
delimitador:
es un carácter que organiza y separa elementos de datos.

etiquetas:
una etiqueta es una marca que se deja en un texto para que el interpretador
digaque debe realizar alguna acción sobre ese texto que este marcado. 
sentencia: es
una oración gramatical. 

sumario:
es un breve resumen del tema del que se trata.
 
<a href="#indice">�nicio </a> 
 <blockquote>
 
<blockquote>
 
 
 

</blockquote>
</blockquote></td>
</tr>
</table>
</div></td>
</tr>
</table>
</body>
</html>

Monografía JavaDoc

Enviado por

Dados do documento

Direitos autorais

Formatos disponíveis

Compartilhar este documento

Compartilhar ou incorporar documento

Opções de compartilhamento

Você considera este documento útil?

Este conteúdo é inapropriado?

Direitos autorais:

Formatos disponíveis

Monografía JavaDoc

Enviado por

Direitos autorais:

Formatos disponíveis

<!doctype html public "-//w3c//dtd html 4.

javadoc es una herramienta integrada al sdk de java, que permite documentar de

es un conjunto de información que se almacena para consultarse o

es un carácter que organiza y separa elementos de datos.</p>

una oración gramatical. </p>

Você também pode gostar

Monografía JavaDoc

Enviado por

Dados do documento

Direitos autorais

Formatos disponíveis

Compartilhar este documento

Compartilhar ou incorporar documento

Opções de compartilhamento

Você considera este documento útil?

Este conteúdo é inapropriado?

Direitos autorais:

Formatos disponíveis

Monografía JavaDoc

Enviado por

Direitos autorais:

Formatos disponíveis

<!doctype html public "-//w3c//dtd html 4.

javadoc es una herramienta integrada al sdk de java, que permite documentar de

es un conjunto de informaci&oacute;n que se almacena para consultarse o

es un car&aacute;cter que organiza y separa elementos de datos.</p>

una oraci&oacute;n gramatical. </p>

Você também pode gostar

es un conjunto de información que se almacena para consultarse o

es un carácter que organiza y separa elementos de datos.</p>

una oración gramatical. </p>