Preguntas etiquetadas con javadoc

Javadoc es un sistema de generación de documentación extensible que lee comentarios especialmente formateados en el código fuente de Java y genera documentación compilada. Por lo general, se usa para producir documentación API en forma de páginas web HTML.


4
¿Cómo escribir Javadoc de propiedades?
A menudo me encuentro con un dilema al escribir javadoc para propiedades / miembros de una clase POJO "simple" que contiene solo propiedades y captadores y definidores (estilo DTO) ... 1) Escriba javadoc para la propiedad o ... 2) Escriba javadoc para el captador Si escribo javadoc para la propiedad, …
93 java  javadoc 

4
Autocompletado de @author en Intellij
Estoy migrando de Eclipse a Intellij Idea. Una cosa que no pude averiguar todavía es el autocompletado de la @authoretiqueta JavaDoc. Al escribir @aen Eclipse, hay dos propuestas: @author - author name @author ¿Cómo consigo la primera propuesta en Intellij (¿es posible?)? Y si es posible, ¿cómo cambio la plantilla …


1
Detalles de la diferencia entre @see y @inheritDoc
He revisado la referencia de JavaDoc , y aunque entiendo la diferencia básica entre @see(varios enlaces) y {@inheritDoc}(exportación del comentario de JavaDoc de la superclase), necesito una aclaración sobre cómo se implementaron realmente las cosas. En Eclipse IDE, cuando selecciono "Generar comentarios de elementos" para el método heredado (desde la …
87 java  javadoc  comments 

2
Cómo aplicar Javadoc a las enumeraciones individuales de una clase
Estoy escribiendo el javadoc para una clase que contiene sus propias enumeraciones. ¿Hay alguna forma de generar javadoc para las enumeraciones individuales? Por ejemplo, ahora mismo tengo algo como esto: /** * This documents "HairColor" */ private static enum HairColor { BLACK, BLONDE, BROWN, OTHER, RED }; Sin embargo, esto …
84 java  enums  javadoc 

4
Reutilización de Javadoc para métodos sobrecargados
Estoy desarrollando una API con muchos métodos con nombres idénticos que solo se diferencian por la firma, que supongo que es bastante común. Todos hacen lo mismo, excepto que inicializan varios valores por defecto si el usuario no quiere especificar. Como ejemplo digerible, considere public interface Forest { public Tree …
81 java  javadoc 

7
Javadoc: ¿saltos de línea sin etiquetas HTML?
Perdón por una probable pregunta tipo FAQ, pero no puedo encontrar la respuesta. Por lo que recuerdo Eclipse, se muestra una línea en blanco en un comentario de Javadoc (en las ventanas emergentes de Javadoc en la fuente) como un salto de línea (con espaciado vertical adicional). En Netbeans, sin …



3
JDK 11+ y Javadoc
Exit code: 1 - javadoc: error - The code being documented uses packages in the unnamed module, but the packages defined in https://docs.oracle.com/en/java/javase/11/docs/api/ are in named modules. ¿Alguien ha podido hacer que javadoc funcione sin tener que cambiar la versión de origen a 1.8 (como se sugiere en otros foros)? …

Al usar nuestro sitio, usted reconoce que ha leído y comprende nuestra Política de Cookies y Política de Privacidad.
Licensed under cc by-sa 3.0 with attribution required.