ventajas usar generar estructura documentación documentacion comentarios codigo all java command-line javadoc

usar - javadoc wiki



¿Comando javadoc genérico que siempre genera todos los javadocs en un árbol dado? (2)

Cuando tengo que generar javadocs para un proyecto nuevo y desconocido, descubro que paso mucho tiempo intentando simplemente escribir el comando correcto, especificando todos los paquetes, todos los árboles de origen, etc. Es lento y propenso a errores: Probablemente me esté perdiendo alguna fuente.

Así que digamos que tengo un directorio myproj, y debajo de él hay algunos paquetes (y varios otros recursos y cosas), y bajo esos directorios de paquetes eventualmente hay algunos directorios src / y luego muchos de mis / awesome / java / project / tipo de paquete de estructuras.

¿Hay un solo comando que siempre recesará sobre TODO y generará TODOS los javadocs en una ubicación de salida? No me importa cuánto tiempo lleve. Algo con muerte cerebral como javadoc -d doc -sourcepath . -subpackages * javadoc -d doc -sourcepath . -subpackages * sería genial. Si esto falla, ¿cuál es la forma más fácil de generar todos los javadocs, sin importar cuál sea la estructura del directorio?


En Windows puedes hacerlo así:

Generar lista de archivos:

dir /s /b *.java > file.lst

Generar javadoc:

javadoc -d outputdir @file.lst


Utilice find para encontrar todos los archivos fuente de Java y luego enviarlos a javadoc :

find . -type f -name "*.java" | xargs javadoc -d outputdir