¿Hay un reemplazo de javadoc que use una sintaxis tipo Wiki?

Question

¿Hay alguna herramienta que reemplace javadoc por algo que tenga más sintaxis estilo Wiki en lugar de la sintaxis HTML de JavaDoc normal?

Uno de mis problemas es que leo principalmente JavaDoc en formato fuente. Incluso para bibliotecas externas trato de tener la fuente adjunta para poder navegar desde mi IDE, verificando la documentación sobre el punto de entrada y si es necesario el código a continuación.

El otro problema es que cosas como listas y muestras de código son complicadas de escribir, especialmente si su IDE insiste en poner estrellas en cada línea. Lo que me gustaría ver es algo que utiliza un tipo de sintaxis Wiki con al menos las siguientes características:

• listas
• bloques de código
• reticulación con los métodos/clases

Hay muchas más cosas que serían agradables, pero creo que estas son las esenciales.

¿Alguien sabe de una herramienta de este tipo?

Answer 1

Hay un proyecto llamado WikiDoclet, nunca lo he usado, pero me gustaría ver lo que piensas de él.

Desde el sitio:

Esta es una extensión de la doclet Javadoc estándar proporcionado con el JDK de Java. Agrega soporte para lo que estoy llamando formato Wiki. Lo que esto significa es que su JavaDoc ahora se puede formatear usando reglas de texto que son más fáciles de ver que las de html incrustadas en JavaDoc. Por ejemplo, para poner énfasis en una pieza de texto la rodea con estrellas. La letra cursiva con subraya. Cuando se ejecuta el documento para producir JavaDoc, estas reglas se evalúan y se realizan sustituciones html. Este formato debería hacer que la lectura del código fuente de Java sea mucho más fácil, ya que ya no estará repleto de etiquetas HTML. Esto es especialmente cierto para las listas con viñetas y para las tablas. Sin embargo, aún se conserva HTML, por lo que puede mezclar y combinar a su gusto.

Para otros formatos de doclet, echa un vistazo a doclet.com.

Answer 2

ahora aquí: http://code.google.com/p/wikidoclet/