¿Cómo escribir un documento de interfaz API de Java?

El lenguaje Java proporciona una poderosa forma de comentarios: comentarios de documentos. Los comentarios de la documentación en el código fuente se pueden extraer en un documento API del sistema. Cuando definimos clases y métodos durante el desarrollo, primero podemos agregar comentarios de documentación y luego usar la herramienta javadoc para generar nuestra propia documentación API.

Los comentarios de la documentación comienzan con una barra seguida de dos asteriscos (/**) y terminan con un asterisco seguido de una barra diagonal (*/). La parte central son todos los comentarios de la documentación. Documentación API.

Simplemente busque el javadoc usted mismo. El ejemplo es el siguiente:

1234567891011121314151617181920212223242526272829/** * Descripción de la clase* * @autor autor* @versión versión*/public class DemoClass { /* * * Propiedades internas: nombre */ nombre de cadena privada ? /** * Método de establecimiento* @nombre de retorno */ nombre de cadena pública() { nombre de retorno } /** * Método de obtención* @nombre de parámetro */ nombre de conjunto vacío; (Nombre de cadena) { this.name = nombre; } }