2010-09-16 11 views
13

Antes de los métodos de Java que tener algo como:¿Qué son las llamadas en java?

/** 
* Takes a number and returns its square root. 
* @param x The value to square. 
* @return The square root of the given number. 
*/ 
public float getSqrt(float x) { 
... 
}

¿Esto tiene un nombre (como en las cadenas de documentación de Python)?

Respuesta

14

En realidad, se llaman documentos comentarios y javadoc es una herramienta para generar esos comentarios en HTML.

Puede encontrar la estructura del comentario de Javadoc en Wikipedia (por ejemplo).

6

Sí, se llama javadoc.

+2

No, javadoc es la herramienta que los procesa. Se llaman comentarios de doc. –

+0

@seanizer que es obviamente por qué las páginas generadas con la herramienta javadoc se suelen llamar "javadoc" e incluso por qué Eclipse y otros IDEs tienen vistas específicas llamadas "Javadoc" utilizadas para mostrar solo esos "comentarios de documentos". – Riduidel

+0

hey, los llamo em JavaDocs, pero no es el nombre oficial. Y el documento oficial que se encuentra detrás del enlace * que * proporcionó tiene el título "Cómo escribir comentarios de documentos para la herramienta Javadoc", no "Cómo escribir comentarios Javadoc" –

Cuestiones relacionadas