Capítulo 3. Aumentar Javadoc con AsciiDoc
Este trabajo se ha traducido utilizando IA. Agradecemos tus opiniones y comentarios: translation-feedback@oreilly.com
James Elliott
Los desarrolladores de Java ya conocen Javadoc. Los que llevan mucho tiempo en esto recuerdan lo transformador que fue, ya que Java se convirtió en el primer lenguaje de uso generalizado en integrar un generador de documentación directamente en el compilador y en la cadena de herramientas estándar. La explosión resultante de documentación de API (aunque no siempre sea grandiosa o pulida) nos ha beneficiado enormemente a todos, y la tendencia se ha extendido a muchos otros lenguajes. Como informó James Gosling, Javadoc fue inicialmente controvertido porque "un buen escritor técnico podría hacer un trabajo mucho mejor", pero hay muchas más API que escritores técnicos para documentarlas, y el valor de tener algo disponible universalmente ha quedado bien establecido.
Sin embargo, a veces necesitas algo más que la documentación de la API, mucho más de lo que cabe en las páginas de resumen de paquetes y proyectos que ofrece Javadoc. Guías y recorridos orientados al usuario final, antecedentes detallados sobre arquitectura y teoría, explicaciones sobre cómo encajar múltiples componentes... nada de esto cabe cómodamente en Javadoc.
Entonces, ¿qué podemos utilizar para satisfacer estas otras necesidades? Las respuestas ...
Get 97 cosas que todo programador Java debe saber now with the O’Reilly learning platform.
O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.
