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.
¿Cómo puedo usar la @linketiqueta para vincular a un método? Quiero cambiar: /** * Returns the Baz object owned by the Bar object owned by Foo owned by this. * A convenience method, equivalent to getFoo().getBar().getBaz() * @return baz */ public Baz fooBarBaz() a: /** * Returns the Baz...
Algo como: /** * See {@linktourl http://google.com}
Tengo un pequeño ejemplo de código que quiero incluir en el comentario Javadoc para un método. /** * -- ex: looping through List of Map objects -- * <code> * for (int i = 0; i < list.size(); i++) { * Map map = (Map)list.get(i); * System.out.println(map.get("wordID")); *...
¿Hay alguna manera de agregar referencias a uno o más de los parámetros de un método desde el cuerpo de documentación del método? Algo como: /** * When {@paramref a} is null, we rely on b for the discombobulation. * * @param a this is one of the parameters * @param b another param */ void...
Desde que uso Maven, he podido construir e instalar en mis proyectos de repositorio locales que tienen etiquetas Javadoc incompletas (por ejemplo, un parámetro faltante). Sin embargo, desde que migré a Java 8 (1.8.0-ea-b90) Maven es absolutamente estricto con las etiquetas de documentación...
La nueva versión del complemento ADT r17 para Eclipse agregó la función para configurar automáticamente las dependencias JAR. Cualquier archivo .jar en la carpeta / libs se agrega a la configuración de compilación ahora. Lamentablemente, el contenedor classpath de dependencias de Android no se...
Al intentar crear comentarios Javadoc a nivel de paquete, ¿cuál es el método preferido? ¿Qué haces? package-info.java Pros Más nuevo Contras Abuso de una clase: las clases son para código, no solo para comentarios package.html Pros Extensión HTML significa que no es código Resaltado...
¿Puedo usar teclas de acceso directo en el estudio de Android para generar comentarios de javadoc? Si no, ¿cuál es la forma más fácil de generar comentarios
Cuál es la diferencia entre /** * comment * * */ y /* * * comment * */ en Java ¿Cuándo debo
¿Alguien podría decirme la diferencia entre javadoc @seey {@link}? O más bien, ¿cuándo usar cuál de
Sé que no es el más importante de los problemas, pero me di cuenta de que puedo poner el bloque de comentarios javadoc antes o después de la anotación. ¿Qué nos gustaría adoptar como estándar de codificación? /** * This is a javadoc comment before the annotation */ @Component public class...
En las API de Java puedo ver los comentarios de Javadoc para los paquetes. ¿Cómo / dónde coloco los comentarios Javadoc para documentar un
¿Cómo puedo escapar del @símbolo en javadoc? Estoy tratando de usarlo dentro de una {@code}etiqueta, que está dentro de las <pre>etiquetas. Ya probé la @secuencia de escape html , pero eso no
Estoy usando Maven (y la integración de Maven Eclipse) para administrar las dependencias de mis proyectos Java en Eclipse. La función de descarga automática para archivos JAR de los repositorios de Maven es un ahorro de tiempo real. Desafortunadamente, no incluye documentación de API y código...
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 a...
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
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 .
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...
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
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...