2010-07-01 12 views
16

Estoy familiarizado con el generador de javadoc sin lujos, sin embargo, me gustaría incluir algunas ecuaciones matemáticas en mi javadoc (en lugar de hacer referencia constantemente a otro documento).Javadoc con ecuaciones?

¿Existe una opción conveniente para hacer algo como incluir/renderizar adecuadamente LaTeX (la más preferida, entonces podría simplemente cortar y pegar) o etiquetas MathML?

Respuesta

1

Tal vez algo como MathJax o jsMath podría ser su solución. Ambas son bibliotecas de JavaScript, por lo que tendrás que encontrar la manera de agregarlas a tus páginas javadocs.

+0

hrm, ¿alguna sugerencia para información de inicio sobre cómo personalizar la salida de javadoc? como en, donde podría comenzar a pensar siquiera en cómo agregar js a lo que produce la herramienta javadoc? – Carl

+0

@Carl, [esta publicación de blog] (http://zverovich.net/2012/01/14/beautiful-math-in-javadoc.html) describe cómo incluir el JavaScript de MathJax en los archivos HTML. Parece que eso es todo lo que se requiere. –

+0

Te das cuenta de que este hilo tiene casi cinco años. Dudo que @Carl esté buscando. – duffymo

0

Si bien no lo he hecho personalmente, hay formas de crear las tuyas usando la API de Doclet o Taglet para crear tu propio Doclet o Taglet. Varios de estos ya se han realizado de acuerdo con una búsqueda rápida que proporciona uno de esos ejemplos http://www.ohloh.net/p/latextaglet

Si se siente lo suficientemente atrevido, el proyecto latextaglet es de código abierto, por lo que es posible que pueda adaptarlo más a sus necesidades.

2

Consulte Doxygen.

Es increíblemente rápido, gratuito y compatible con LaTeX incorporado.

+0

Lo busqué un poco; la opción LaTeX parece ser solo compatible cuando se genera documentación ps/pdf. ¿Existe una opción para generar el estilo convencional javadoc (que me gusta mucho) con, por ejemplo, imágenes generadas desde LaTeX embedded? Puedo manejar una pequeña configuración, pero no estoy buscando programar mi generador de documentación. – Carl

+1

Doxygen también incorporará LaTeX en la documentación HTML generada utilizando imágenes. Confirmé esto usando Doxygen en mi código hace un minuto. – nsanders