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?
Respuesta
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.
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. –
usted puede considerar algunas herramientas en tiempo de compilación como Lombok:
- 1. Visibilidad Java campo privado
- 2. Etiqueta @since javadoc automática para las versiones
- 3. ¿Cómo me burlo de un campo privado?
- 4. ¿Propagación de excepción en subprocesos?
- 5. C# campo protegido a privado, agregar propiedad, ¿por qué?
- 6. ¿Cómo puede hibernate acceder a un campo privado?
- 7. Busque un campo privado con Reflection?
- 8. Probar un campo privado usando MSTest
- 9. Establecer el valor del campo estático privado
- 10. acceso a la propiedad automática - C#
- 11. ¿Es privado un campo C# por defecto?
- 12. Propagación de excepción Python
- 13. ¿Una propiedad abstracta crea un campo de respaldo privado?
- 14. Reflejando un campo privado de una clase base
- 15. Inline Argumentos función de propagación
- 16. Propagación de versión en Maven
- 17. Propagación de eventos en Qt
- 18. Propagación de eventos en Javascript
- 19. agregando datos de propagación a gráficos de puntos en R
- 20. Refactorización para mover un campo privado de una clase a su clase auxiliar?
- 21. Jquery clic evento propagación
- 22. ¿Cómo escribir enlaces a javadoc?
- 23. Burbujeo de eventos y Propagación de detención
- 24. ¿Cómo acceder y mutar el campo privado en scala?
- 25. @Transactional (propagación = Propagation.REQUIRED)
- 26. Transacciones de muelles con propagación de apoyos
- 27. Propagación de eventos de teclado en winforms
- 28. Cambiar campos final privado a través de la reflexión
- 29. Cambiar automáticamente de público a privado (Java)
- 30. C++ ¿Es privado realmente privado?
No estoy seguro, pero me acaba de JavaDoc los captadores y definidores, ya que son parte de la API pública. – Steve
... De hecho, solo utilizaría los métodos Javadoc que forman parte de la API. –