Tabla de contenido:

¿Dónde pongo los comentarios de Javadoc?
¿Dónde pongo los comentarios de Javadoc?

Video: ¿Dónde pongo los comentarios de Javadoc?

Video: ¿Dónde pongo los comentarios de Javadoc?
Video: ¿ Qué es JavaDoc y como generarlo en Eclipse ? 2024, Diciembre
Anonim

los javadoc la utilidad te permite poner tu comentarios justo al lado de su código, dentro de su ". Java "archivos de origen. Cuando esté satisfecho con su código y comentarios , simplemente ejecuta el javadoc comando, y su estilo HTML documentación se crea automáticamente para usted.

Entonces, ¿cómo se agregan comentarios a un Javadoc?

Tenga en cuenta lo siguiente cuando utilice Agregar comentario de Javadoc (Alt + Mayús + J): Para agregar a comentario a un campo, coloque el cursor en la declaración del campo. Para agregar a comentario a un método, coloque el cursor en cualquier lugar del método o en su declaración.

¿Cuál es el uso de los comentarios de Javadoc? Javadoc es una herramienta que viene con JDK y es usó para generar Java documentación de código en formato HTML de Java código fuente, que requiere documentación en un formato predefinido. A continuación se muestra un ejemplo simple donde las líneas dentro de / *…. */ están Java multilínea comentarios.

De ahí, ¿dónde pongo Javadoc?

Puede colocar comentarios de JavaDoc en cualquiera de las tres ubicaciones diferentes de un archivo fuente:

  1. Inmediatamente antes de la declaración de una clase pública.
  2. Inmediatamente antes de la declaración de un campo público.
  3. Inmediatamente antes de la declaración de un método o constructor público.

¿Cómo escribo comentarios de Javadoc en Intellij?

3 respuestas. Al escribir / ** + y luego presionar Enter arriba, se creará una firma de método Javadoc talones para usted. Usted puede usar la acción 'Fix doc comentario '. No tiene un atajo predeterminado, pero puede asignarle el atajo Alt + Shift + J en el mapa de teclas, porque este atajo no se usa para nada más.

Recomendado: