En Java existen comentarios de línea con // y bloques de comentario que comienzan con /* y terminan con */. Por ejemplo:
// Comentario de una linea
/* comienzo de comentario
continua comentario
fin de comentario */
El JDK proporciona una herramienta para generar páginas HTML de documentación a partir de los comentarios incluidos en el código fuente. El nombre de la herramienta es javadoc. Para que javadoc pueda generar los textos HTML es necesario que se sigan unas normas de documentación en el fuente, que son las siguientes:
| Tipo de tag | Formato | Descripción |
| Todos | @see | Permite crear una referencia a la documentación de otra clase o método. |
| Clases | @version | Comentario con datos indicativos del número de versión. |
| Clases | @author | Nombre del autor. |
| Clases | @since | Fecha desde la que está presente la clase. |
| Métodos | @param | Parámetros que recibe el método. |
| Métodos | @return | Significado del dato devuelto por el método |
| Métodos | @throws | Comentario sobre las excepciones que lanza. |
| Métodos | @deprecated | Indicación de que el método es obsoleto. |
Toda la documentación del API de Java está creada usando esta técnica y la herramienta javadoc.
import java.util.*;
/** Un programa Java simple.
* Envia un saludo y dice que día es hoy.
* @author Antonio Bel
* @version 1
*/
public class HolaATodos {
/** Unico punto de entrada.
* @param args Array de Strings.
* @return No devuelve ningun valor.
* @throws No dispara ninguna excepcion.
*/
public static void main(String [ ] args) {
System.out.println("Hola a todos");
System.out.println(new Date());
}}
SUN recomienda un estilo de codificación que es seguido en el API de Java y en estos apuntes que consiste en: