Cuando programamos en Java, a veces conviene tener unos pequeños scripts que ayuden a ejecutar la aplicación, a chequear la documentación y a documentarla. Estos son los que he estado usando yo tanto para GNU/Linux como para Windows.
ejecuta
Ejecuta el fichero jar que le indiquemos y es válido tanto para GNU/Linux como para Windows, por lo tanto con su código podemos crear los scripts ejecuta.sh y ejecuta.bat:
java -jar Fichero.jar
chequea
Comprueba que los ficheros fuente estén correctamente documentados antes de pasar el JavaDoc. Requiere que en la carpeta lib exista con la libreria doccheck.jar dentro y que el código fuente se encuentre en el directorio src con el paquete comenzando en com.
chequea.sh
mkdir ./doccheck javadoc -doclet com.sun.tools.doclets.doccheck.DocCheck -docletpath ./lib/doccheck.jar -d ./doccheck -sourcepath ./src -subpackages com -private
chequea.bat
mkdir .\doccheck javadoc -doclet com.sun.tools.doclets.doccheck.DocCheck -docletpath .\lib\doccheck.jar -d .\doccheck -sourcepath .\src -subpackages com -private
documenta
Genera la documentación JavaDoc buscando el paquete com y la codificación de los ficheros fuente en UTF-8.
documenta.sh
mkdir ./doc javadoc -sourcepath src -d doc -subpackages com -encoding UTF-8 -version -author -private
documenta.bat
mkdir .\doc javadoc -sourcepath src -d doc -subpackages com -encoding UTF-8 -version -author -private
Últimos comentarios