Preguntas etiquetadas con javadoc

He escrito comentarios de estilo Javadoc como este en el código de mi proyecto: /** * Description... * * @param ... * @return ..... */ ¿Cómo puedo generar archivos HTML Javadoc usando el IDE de Eclipse?

165 java  eclipse  javadoc 

He estado revisando la documentación de javadoc en el sitio de Sun, tratando de encontrar si hay una etiqueta javadoc que pueda usarse para documentar la firma de tipo genérico de una clase o método. Algo parecido @typeparam, similar a lo habitual @param, pero aplicable tanto a los tipos como …

165 java  javadoc 

Cerrada . Esta pregunta está basada en la opinión . Actualmente no está aceptando respuestas. ¿Quieres mejorar esta pregunta? Actualice la pregunta para que pueda ser respondida con hechos y citas editando esta publicación . Cerrado hace 2 años . Mejora esta pregunta Actualmente estoy comenzando con Python y tengo …

162 python  documentation  javadoc  docstring 

Recientemente me mudé de Eclipse a Android Studio y me está gustando. Sin embargo, echo de menos la función Javadoc on hover de Eclipse. Seguí las instrucciones aquí para agregar la funcionalidad, sin embargo, mis elementos emergentes no contienen Javadoc. Si uso mi acceso directo de documentación Ctrl+ Shift+ Space, …

160 android  android-studio  intellij-idea  javadoc 

Quiero cambiar el autor automático que aparece cuando creo un archivo en AndroidStudio. /** * Created by a556520 on 16/01/14. */ public class POI { El autor toma 'a556520' pero quiero que aparezca mi nombre y no el número de empleados. ¿Es eso posible? No encontré en la configuración.

153 java  android  android-studio  javadoc 

En Eclipse, puedo presionar Alt+ Shift+ Jy obtener un comentario de javadoc generado automáticamente con campos, devoluciones o lo que sea aplicable para ese comentario específico de javadoc. Supongo que IntelliJ IDEA tiene esta característica. ¿Alguien puede decirme si hay un atajo de teclado para esto?

150 intellij-idea  keyboard-shortcuts  javadoc 

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 esta pregunta ¿Hay un buen ejemplo de un archivo fuente …

140 java  javadoc 

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

124 java  comments  javadoc  setter  getter 

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 posible?

123 java  eclipse  templates  javadoc 

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 …

121 java  javadoc 

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 javadoc?

121 java  javadoc 

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 veo …

120 autocomplete  intellij-idea  javadoc 

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 7.2

113 netbeans  javadoc  netbeans-7 

¿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 el material sobre …

110 java  methods  javadoc 

¿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 la descripción?

109 java  interface  comments  javadoc