tutorial generar documentar comentarios codigo java pdf javadoc maven-pdf-plugin

documentar - generar comentarios javadoc eclipse



Cómo generar un PDF desde JavaDoc(incluyendo resumen y resúmenes de paquetes) (4)

He escrito una extensa documentación de JavaDoc en mi aplicación y he agregado mucha información útil en los archivos overview.html y package.html (incluidos los enlaces de los primeros en las ilustraciones en doc-files/ ). El complemento Javadoc de Maven utiliza la herramienta javadoc estándar para generar el conjunto de marcos JavaDoc clásico, pero ahora necesito generar un PDF con toda la documentación.

AurigaDoclet genera archivos PDF muy bonitos, y también pude hacer funcionar DocFlex . Sin embargo, ambos ignoran mis archivos overview.html y package.html (probados tanto dentro como fuera de Maven; el PDF será una cosa única, ya que prefiero tener los HTML a largo plazo).

¿Alguien sabe cómo hacer que AurigaDoclet reconozca mis archivos que no son de Java? O, alternativamente, ¿otro para generar un PDF de aspecto decente a partir del código fuente o el HTML generado por JavaDoc?

¡Gracias!

Dado en el clavo. Después de probar todas las herramientas posibles para generar directamente desde la fuente, volví a HTMLDOC . No es compatible con JavaDoc, pero está tan bien construido que algunos ajustes son suficientes para que genere un PDF bastante utilizable.

Aquí va una descripción paso a paso de cómo lo hice:

  1. Descargue una versión gratuita del software (la versión oficial del sitio requiere una licencia, pero es GPL-ed, por lo que puede encontrar binarios gratuitos como este , que es un instalador sencillo y funcional para Windows);

  2. Genere sus documentos HTML tradicionales de la forma que prefiera (Ant, Maven, javadoc de línea de comandos: su elección);

  3. La GUI es agradable, pero agregar todos los archivos manualmente puede ser engorroso, así que simplemente cree un archivo .book con el Tipo de documento configurado en "Página web", agregue uno de los archivos HTML de la carpeta raíz de su javadoc generado (por ejemplo, resumen-resumen). html, cualquiera lo hará, es solo como referencia en el paso 5). En la pestaña Salida, seleccione el formato PDF y establezca un nombre para él, y agregue otras opciones al contenido de su corazón (logotipos, colores, muchas cosas interesantes aquí). Guarde este proyecto (por ejemplo, myjavadocpdf.book ) y cierre la GUI

  4. Genera una lista de todos los archivos HTML en tu javadoc. Lo hice con el comando de búsqueda de Cygwin (mis días de shell de DOS / cmd han terminado), pero puedes hacer lo que quieras, siempre que obtengas una lista de archivos. En mi caso un find . | grep html$ | sort -r > files.txt find . | grep html$ | sort -r > files.txt find . | grep html$ | sort -r > files.txt hizo el truco; Para los usuarios de Windows, dir /s/b *.html > files.txt debería hacer lo mismo (pero tenga en cuenta que es posible que tenga que reemplazar / s con / s si aparecen así en el próximo paso).

  5. Abra el archivo .book generado en el paso 3 en su editor de texto puro favorito (como programador, debe tener opiniones firmes al respecto, así que mantendré mis opiniones en mí mismo - NOT ;-)) y adjunte la lista generada en el paso 4 a este Archivo .book (mantiene la lista de archivos al final, haciendo la vida realmente fácil). No se olvide de arreglar las rutas relativas, si es necesario con una búsqueda / reemplazo global (es por eso que necesita al menos un archivo agregado en el paso 3, para ver qué patrón de ruta de acceso espera htmldoc);

  6. Ahora debes ordenar los archivos en un orden conveniente. Pongo primero mi descripción general, luego las descripciones de los paquetes y cada clase, luego el índice completo y todo lo demás al final. Recuerde que cualquier archivo que elimine se convertirá en un enlace externo (por lo tanto, roto), así que elija sabiamente;

  7. Guarde su archivo .book y vuelva a abrirlo en HTMLDOC. Voila: todos los archivos añadidos y ordenados. Haga clic en Generar. ¡Eso es!

Es posible que desee jugar con las imágenes (sugerencia: use HTML ancho / alto, no estilo / css). Al final, el archivo resultante es sorprendentemente bueno: se ve bien y es totalmente navegable para enlaces internos y externos. Impresionante si considera que la herramienta no es Java (Doc) en absoluto ...

Si esta pregunta fue eliminada de todos modos, puedo usar esto para vincular mi proyecto ltxdoclet .

Esto crea desde la documentación de origen (al ser un complemento de JavaDoc) en formato LaTeX, que luego puede pasar a través de PdfLaTeX para producir un PDF.

Opcionalmente también puede incluir código fuente bastante impreso.