Preguntas etiquetadas con javadoc

Usando JavaDoc, ¿cómo puedo hacer referencia al valor de un campo estático final en la clase? Quiero que ???en este ejemplo se reemplace por el valor del campo STATIC_FIELD. /** * This is a simple class with only one static field with the value ???. */ public class Simple { …

96 java  documentation  javadoc 

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 

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 …

93 intellij-idea  javadoc 

Suponga que, como parte de la documentación de su código (Javadoc), desea indicar que las relaciones entre los elementos utilizan sangría profunda. ¿Cómo puedo crear una lista anidada como: algún elemento algún otro elemento sin embargo, algún otro elemento

88 documentation  javadoc  indentation  nested-lists 

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 

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 

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 

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 …

81 java  netbeans  comments  javadoc 

Cerrado. Esta pregunta no cumple con las pautas de Stack Overflow . Actualmente no acepta respuestas. ¿Quieres mejorar esta pregunta? Actualice la pregunta para que esté relacionada con el tema de Stack Overflow. Cerrado hace 6 años . Mejora esta pregunta Seamos realistas: no es necesario ser diseñador para ver …

80 java  documentation  javadoc 

Actualmente estoy trabajando con JavaFX. Cada vez que coloco el cursor sobre un método de JavaFX, me da el siguiente error: 'Note: This element neither has attached source nor attached Javadoc and hence no Javadoc could be found' ¿Cómo debo resolver esto? ¿Cómo puedo adjuntar el javadoc o la fuente …

79 java  eclipse  javadoc  javafx-2 

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)? …

13 java  maven  javadoc  java-11  maven-javadoc-plugin 

¿Cómo se supone que se deben documentar los parámetros de Java Record ? Me refiero a los parámetros que terminan convirtiéndose en parámetros de constructor, campos de clase. Lo intenté: /** * @param name the name of the animal * @param age the age of the animal */ public record …

12 java  intellij-idea  javadoc  java-14  java-record