Bueno, cuando estudie Java en la universidad nos explicaron todas las ventajas que tenia poder documentar tus clases con JavaDoc y comprobe la facilidad con la que un programador podia acceder a información sobre las librerias, clases y código "ajeno" que utilizaba en sus programas.
Pero ahora estoy documentando un proyecto por mi cuenta y me surgen dudas de la limitación que puede tener su utilización. Partimos de que tu documentas unas clases para que el que no tenga el código fuente (o no quiera mirarselo a pelo) pueda comprender que prestaciones le ofrecen unas clases y métodos ya implementadas, por tanto no se documentan las clases o mètodos privados.
Pero, ¿y si quiero documentar mi trabajo en formato web para que alguien vea que hace cada método aunque sea privado?. Quiero decir, si hago un juego, puedo querer dejar constancia de mi trabajo fuera del código. En principio no solo para que se utilicen mis clases por otros, sino para explicar como funcionan también internamente (por lo que necesitamos de la documentación de mètodos privados).
Seguramente solo se reduce a poner algun parámetro a JavaDoc para que también contemple la docu de los mètodos y clases privadas. Pero lo importante es si pensais que es una buena forma de hacerlo, o para esto considerais mejor poner comentarios "estandar" (no javadoc) y a la marxa. ¿Alguna otra sugerencia para documentar bien el funcionamiento interno?
Bueno, espero que os parezca un tema interesante de comentar.
Aunque sea por interés particular :rolleyes:
Saludos y gracias
Edit: Por cierto, para mostrar tanto publicos, protecteds, como privados, el parámetro de JavaDoc es -private. Si ya lo sé, sencillo, ¿pero sigue siendo una buena opción?.
Pero ahora estoy documentando un proyecto por mi cuenta y me surgen dudas de la limitación que puede tener su utilización. Partimos de que tu documentas unas clases para que el que no tenga el código fuente (o no quiera mirarselo a pelo) pueda comprender que prestaciones le ofrecen unas clases y métodos ya implementadas, por tanto no se documentan las clases o mètodos privados.
Pero, ¿y si quiero documentar mi trabajo en formato web para que alguien vea que hace cada método aunque sea privado?. Quiero decir, si hago un juego, puedo querer dejar constancia de mi trabajo fuera del código. En principio no solo para que se utilicen mis clases por otros, sino para explicar como funcionan también internamente (por lo que necesitamos de la documentación de mètodos privados).
Seguramente solo se reduce a poner algun parámetro a JavaDoc para que también contemple la docu de los mètodos y clases privadas. Pero lo importante es si pensais que es una buena forma de hacerlo, o para esto considerais mejor poner comentarios "estandar" (no javadoc) y a la marxa. ¿Alguna otra sugerencia para documentar bien el funcionamiento interno?
Bueno, espero que os parezca un tema interesante de comentar.
Aunque sea por interés particular :rolleyes:
Saludos y gracias
Edit: Por cierto, para mostrar tanto publicos, protecteds, como privados, el parámetro de JavaDoc es -private. Si ya lo sé, sencillo, ¿pero sigue siendo una buena opción?.
