2011-07-13 937 views
7

He documentado mis campos privados de frijol con Javadoc, explicando para qué sirve cada campo. ¿Puedo propagar estas documentaciones de alguna manera a los buscadores/instaladores correspondientes para reducir las duplicaciones de documentación? ¿Hay algún tipo de macro Javadoc para esto al menos?¿Propagación automática de javadoc de campo privado a getters/setters?

+2

No estoy seguro, pero me acaba de JavaDoc los captadores y definidores, ya que son parte de la API pública. – Steve

+2

... De hecho, solo utilizaría los métodos Javadoc que forman parte de la API. –

Respuesta

5

puedan vincular el comentario Javadoc de captadores y definidores en el ámbito privado mediante la adición de un enlace javadoc:

{@link Class#field} 

sin embargo no recomendaría este. Como dijeron los comentaristas anteriores, solo documentaría los getters y setters correctamente. Javadoc documenta su API pública, a la que los getters y setters pueden pertenecer. Sus campos privados no pertenecen a la API pública.

+2

Quizás al revés: agregue un enlace de los campos al getter/setter, de modo que quien mire la documentación con '-private' puede saltar a la descripción. –

Cuestiones relacionadas