Cerrado. Esta pregunta no cumple con las pautas de desbordamiento de pila . Actualmente no está aceptando respuestas. ¿Quieres mejorar esta pregunta? Actualice la pregunta para que sea sobre el tema de Stack Overflow. Cerrado hace 3 años . Mejora...
¿Qué convención usas para comentar captadores y establecedores? Esto es algo que me he preguntado durante bastante tiempo, por ejemplo: /** * (1a) what do you put here? * @param salary (1b) what do you put here? */ public void setSalary(float salary); /* * (2a) what do you put here? *...
No me gustan los Javadocs predeterminados generados para mí cuando creo una Clase o métodos, especialmente la variable @author, que es el nombre de usuario actual del sistema en mi ventana de Windows. Me gustaría cambiarlo. es
Usando Javadoc 1.5, no he podido crear un @link a un valor de enumeración. Lo que me gustaría hacer es crear una enumeración como esta: public enum Planet { /** * MERCURY is a fun place. */ MERCURY, /** * VENUS is more fun. */ VENUS, /** * But nothing beats the Earth. */ EARTH, /** *...
Si escribo <xmlElement>en un javadoc, no aparece, porque las etiquetas tienen funciones especiales para formatear textos. ¿Cómo puedo mostrar estos caracteres en un
Cuando estoy codificando en Netbeans, autocompleta el código y muestra Javadocs. Sin embargo, cuando estoy usando Intellij IDEA, si hago clic en Ctrl+Space puedo ver el autocompletar y si hago clic en Ctrl+Q puedo ver el javadoc por separado. ¿Es posible ver el Javadoc del elemento cada vez que...
Al crear una nueva clase o interfaz en Netbeans IDE, aparece una etiqueta "@author ....". ¿Cómo cambiar su valor? Si es posible, me gustaría cambiarlo usando el menú de Netbeans y no editando algunos archivos de configuración :) Estoy usando Netbeans
¿Cuándo lo uso @seecuando trato con JavaDocs? Cual es su uso? Por ejemplo, si MethodAlas llamadas MethodBa continuación, tengo que poner @seeen MethodBjavadoc 's y referencia MethodAporque es lo que se llama, o tengo que poner una referencia a MethodBpartir de MethodAya que está llamando. He leído...
¿Es una práctica correcta agregar comentarios Javadoc en la interfaz y agregar comentarios que no sean Javadoc en la implementación? La mayoría de los IDE generan comentarios que no son de JavaDoc para implementaciones cuando genera comentarios automáticamente. ¿No debería el método concreto tener...
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 { /** * We can...
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,...
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...
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
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...
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,...
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,...
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...
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...
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...
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...