Si se usan ciertas convenciones en el código fuente Java (como comenzar un comentario con /** y terminarlo con */), javadoc puede fácilmente generar páginas HTML con el contenido de esos comentarios, que pueden visualizarse en cualquier navegador. La documentación del API de Java ha sido creada de este modo. Esto hace que el trabajo de documentar el código de nuevas clases Java sea trivial.
Las plantillas:
- Son sugerencias de código asociadas a palabras clave.
- Se hallan definidas en Preferences > Java > Editor >Templates.
- Es aconsejable examinar todas, ya que pueden ahorrar mucho trabajo.
- Muchas de ellas utilizan nombres similares a las construcciones Java que encapsulan (
try, for, while, if,...). - Podemos definir y crear nuestras propias plantillas.
- Además existen plantillas Javadoc predefinidas.
Una plantilla se compone de:
- un nombre,
- una descripción,
- un contexto en función del lenguaje (en java, si estamos en el código, en el javadoc,...) y
- un pattern, que es el código de la plantilla. Dentro del código de la plantilla podemos usar texto fijo o una serie de variables predefinidas, por ejemplo:
${cursor}: posición en la que se establecerá el cursor de texto tras desplegar el código de la plantilla.${enclosing_type}: tipo de la clase en la que nos encontramos.${enclosing_method}: nombre del método en el que nos encontramos.${year}: año en curso.${time}: hora en curso.
Estas plantillas se mostrarán como sugerencias en el código tras comenzar a escribir su nombre y pulsar CTRL+ espacio. Lo más interesante es que nosotros podemos crearnos nuestras propias plantillas, además de modificar las existentes. Para ello no tenemos más que añadir una nueva desde la opción de "Templates", asignarle un nombre, descripción y elegir el código que queremos que se muestre al seleccionar la misma.