Javadoc
Páginas: 11 (2527 palabras)
Publicado: 25 de abril de 2011
Prácticas de Lenguajes de Programación (Java) Ingeniería Informática Curso 2004-2005 . Práctica 1 Universitat de València
Índice
1. Generación automática de documentación (javadoc).............................................. 1 1.1 Introducción ....................................................................................................... 1 1.2 La herramienta Javadoc.................................................................................... 1 1.3 Comentando el código Java .............................................................................. 1 2 Guía de estilo de Java ............................................................................................. 5 2.1Clases................................................................................................................ 6 2.2 Constructores .................................................................................................... 6 2.3 Métodos............................................................................................................. 6 2.4 Atributos ............................................................................................................ 7 2.5Comentarios a bloques de código ..................................................................... 7 3 Desarrollar y ejecutar una aplicación sencilla .......................................................... 7 4 Cuestiones ............................................................................................................... 7
1. Generación automática de documentación (javadoc)1.1 Introducción
Javadoc es una herramienta para generar documentación de código Java a partir de comentarios (escritos según ciertas reglas) que se intercalan en el código fuente. La documentación se genera en formato HTML y, por tanto, se puede consultar fácilmente con un navegador. Un ejemplo muy ilustrativo de documentación generada con javadoc es la especificación de la API (=ApplicationProgram Interface) para la plataforma J2SE (http://java.sun.com/j2se/1.4.2/docs/api/index.html). Una explicación exhaustiva de la herramienta javadoc y de la forma de intercalar los comentarios en el código fuente para que puedan ser interpretados por la herramienta la podemos encontrar en la Javadoc Home Page (http://java.sun.com/j2se/javadoc/index.jsp). En esta práctica se van a presentar sólo losaspectos más relevantes.
1.2
La herramienta Javadoc
La sintaxis con la que tiene que ser invocada la herramienta es: javadoc [opciones] Clase Aunque existe una gran variedad de opciones, estas son algunas de las que nos pueden resultar útiles en el desarrollo de las prácticas: • javadoc -public Clase : muestra sólo las clases y los miembros públicos • javadoc -protected Clase : muestra lasclases y los miembros protegidos (protected) y públicos • javadoc -package Clase : muestra las clases y los miembros con acceso de paquete, los protegidos y los públicos • javadoc -private Clase : muestra todas las clases y todos los miembros, incluyendo los privados
1.3
Comentando el código Java
Se pueden escribir comentarios para documentación para cualquier paquete, clase, interfaz,constructor, método y atributo. Los comentarios a partir de los cuales se genera la documentación son llamados informalmente "comentarios Javadoc" ("Javadoc comments"). Un comentario Javadoc consta de un texto escrito con una cierta sintaxis entre los caracteres /** (que marca el principio del comentario) y */ (que
Lenguajes de Programación
Página 1 de 8
Prácticas de Lenguajes deProgramación (Java) Ingeniería Informática Curso 2004-2005 . Práctica 1 Universitat de València marca el final). El texto del comentario puede extenderse a lo largo de varias líneas. Ejemplo: /** * Este es el típico formato de un comentario simple * que se extiende a lo largo de dos líneas */ Aunque para ahorrar espacio se puede poner un comentario en una sola línea /** Este comentario ocupa sólo una...
Índice
1. Generación automática de documentación (javadoc).............................................. 1 1.1 Introducción ....................................................................................................... 1 1.2 La herramienta Javadoc.................................................................................... 1 1.3 Comentando el código Java .............................................................................. 1 2 Guía de estilo de Java ............................................................................................. 5 2.1Clases................................................................................................................ 6 2.2 Constructores .................................................................................................... 6 2.3 Métodos............................................................................................................. 6 2.4 Atributos ............................................................................................................ 7 2.5Comentarios a bloques de código ..................................................................... 7 3 Desarrollar y ejecutar una aplicación sencilla .......................................................... 7 4 Cuestiones ............................................................................................................... 7
1. Generación automática de documentación (javadoc)1.1 Introducción
Javadoc es una herramienta para generar documentación de código Java a partir de comentarios (escritos según ciertas reglas) que se intercalan en el código fuente. La documentación se genera en formato HTML y, por tanto, se puede consultar fácilmente con un navegador. Un ejemplo muy ilustrativo de documentación generada con javadoc es la especificación de la API (=ApplicationProgram Interface) para la plataforma J2SE (http://java.sun.com/j2se/1.4.2/docs/api/index.html). Una explicación exhaustiva de la herramienta javadoc y de la forma de intercalar los comentarios en el código fuente para que puedan ser interpretados por la herramienta la podemos encontrar en la Javadoc Home Page (http://java.sun.com/j2se/javadoc/index.jsp). En esta práctica se van a presentar sólo losaspectos más relevantes.
1.2
La herramienta Javadoc
La sintaxis con la que tiene que ser invocada la herramienta es: javadoc [opciones] Clase Aunque existe una gran variedad de opciones, estas son algunas de las que nos pueden resultar útiles en el desarrollo de las prácticas: • javadoc -public Clase : muestra sólo las clases y los miembros públicos • javadoc -protected Clase : muestra lasclases y los miembros protegidos (protected) y públicos • javadoc -package Clase : muestra las clases y los miembros con acceso de paquete, los protegidos y los públicos • javadoc -private Clase : muestra todas las clases y todos los miembros, incluyendo los privados
1.3
Comentando el código Java
Se pueden escribir comentarios para documentación para cualquier paquete, clase, interfaz,constructor, método y atributo. Los comentarios a partir de los cuales se genera la documentación son llamados informalmente "comentarios Javadoc" ("Javadoc comments"). Un comentario Javadoc consta de un texto escrito con una cierta sintaxis entre los caracteres /** (que marca el principio del comentario) y */ (que
Lenguajes de Programación
Página 1 de 8
Prácticas de Lenguajes deProgramación (Java) Ingeniería Informática Curso 2004-2005 . Práctica 1 Universitat de València marca el final). El texto del comentario puede extenderse a lo largo de varias líneas. Ejemplo: /** * Este es el típico formato de un comentario simple * que se extiende a lo largo de dos líneas */ Aunque para ahorrar espacio se puede poner un comentario en una sola línea /** Este comentario ocupa sólo una...
Leer documento completo
Regístrate para leer el documento completo.