Preguntas etiquetadas con javadoc

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

864 java  hyperlink  javadoc 

Algo como: /** * See {@linktourl http://google.com} */

768 java  url  javadoc  hyperlink 

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")); * System.out.println(map.get("word")); * …

531 java  html  javadoc 

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

313 java  arguments  javadoc 

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 faltantes y me muestra muchos errores de …

312 java  maven  migration  java-8  javadoc 

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 puede modificar. ¿Cómo puedo adjuntar javadoc …

254 android  eclipse  adt  javadoc 

Actualmente estoy haciendo referencia a métodos en otras clases con esta sintaxis Javadoc: @see {@link com.my.package.Class#method()} Y en lo que entiendo de la documentación, esta es la forma correcta de hacerlo. Pero ahora a la parte divertida, o frustrante. Cuando genero este javadoc, en primer lugar obtengo el siguiente error: …

238 java  javadoc 

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 de sintaxis en IDE / editores …

230 java  javadoc 

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

204 android-studio  javadoc 

Cuál es la diferencia entre /** * comment * * */ y /* * * comment * */ en Java ¿Cuándo debo usarlos?

191 java  comments  javadoc 

¿Alguien podría decirme la diferencia entre javadoc @seey {@link}? O más bien, ¿cuándo usar cuál de ellos?

184 java  javadoc 

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 …

184 java  coding-style  annotations  javadoc  code-documentation 

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

182 java  packages  javadoc 

¿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 funcionó.

180 java  escaping  javadoc 

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 fuente. ¿Cómo puedo configurar …

176 eclipse  maven-2  javadoc