¿Es necesario generar javadoc como parte del proceso de compilación?

Question

¿Es necesario generar javadoc como parte del proceso de compilación?

Answer 1

No, no es necesario

Answer 2

bien no hay nada realmente lo que obligó a hacerlo, pero si se desea distribuir sus artefactos de construcción como una biblioteca utilizable sin duda ayuda a tener Javadocs bien escrito que la gente puede ver antes incluso descargan su JAR.

Answer 3

No. Lo que elija hacer en un proceso de compilación depende de usted (o del cliente). Algunos sistemas de compilación pueden incluir la generación de JavaDoc de forma predeterminada, pero debería ser fácil de desactivar.

Answer 4

No menciona si se trata de una compilación para, por ejemplo, una aplicación web o una biblioteca para su distribución. Como han mencionado otras respuestas, no es realmente necesario, pero tanto para una aplicación web mantenida internamente como para una biblioteca distribuida externamente, la documentación (en forma de javadoc) será extremadamente útil.

Answer 5

Si su proceso de construcción utiliza Ant, yo diría que puede no ser necesario, pero hacerlo no debería ser una dificultad en absoluto. Simplemente use la tarea javadoc, generela y termine con ella.

Answer 6

No, en absoluto.

Si la mayoría de los usuarios de su código acceden directamente a los archivos Java y utilizan un IDE, entonces probablemente ya estén leyendo sus JavaDocs mediante los elementos emergentes en el editor de código. Puede que esté más actualizado que la versión que está registrada o que se está compilando (a menos que tenga compilaciones continuas).

Si expone las versiones provisionales a los clientes (por ejemplo, usted es un proyecto de código abierto), proporcionar JavaDocs en lugar de solo archivos de clase lo vincula a una semántica específica. Tiene sentido proporcionar un control más estricto sobre su API y sus JavaDocs describen esencialmente su API.

Si no desea que nadie use sus interfaces públicas (por ejemplo, las mantiene abiertas para futuros complementos), no puede evitarlo, pero puede evitar alentarlo al proporcionar JavaDocs.

Answer 7

Usted decide si es necesario o no. Personalmente, no genero javadoc y otros informes pesados ​​(que son un poco caros de generar) en cada compilación, quiero mantener la compilación ejecutada en las máquinas de desarrollo y por el motor de integración continua lo más rápido posible (el motor de integración continua crea y publica archivos fuente sin embargo). La generación de informes se realiza durante la construcción nocturna.

Answer 8

¿Es necesario generar javadoc como parte del proceso de compilación?

Sin