Preguntas etiquetadas con javadocs

Recientemente he estado trabajando en la refactorización de partes de la base de código con la que estoy trabajando actualmente, no solo para comprenderlo mejor, sino también para que sea más fácil para otros que están trabajando en el código. Tiendo a inclinarme al lado de pensar que el código …

18 java  documentation  refactoring  javadocs 

¿Existe un buen término que sea similar pero diferente de "desaprobar" para significar que un método o API está en la base del código pero que no debe usarse porque su implementación no está completa o probablemente cambiará? (Sí, lo sé, esos métodos no deberían ser públicos, yada yada yada. …

12 documentation  terminology  api  documentation-generation  javadocs 

En el JavaDoc para X509Certificate getSubjectDN()esto dice: Denigrado , reemplazado por getSubjectX500Principal (). Estoy acostumbrado a ver en desuso los métodos que ya no deberían usarse, pero no denigrados. Encontré un informe de error sobre este caso particular donde se cerró con comentarios: Esto no es un error. "Desaprobado" está …

11 java  terminology  javadocs 

Estoy trabajando en una pequeña biblioteca que proporciona implementaciones de métricas de cadena básicas y bien conocidas. Principalmente para mi propia educación. Entonces, el desarrollo ocurre cada vez que tengo un poco de tiempo libre. Debido a esto, he automatizado la mayoría de los procesos para poder lanzar una versión …

9 java  documentation  javadocs 

Quiero escribir Javadoc en SECO. Pero el documento de Oracle sobre Javadoc dice escribir lo mismo nuevamente en el comentario del método de sobrecarga. ¿No puedo evitar la repetición?

9 documentation  comments  dry  javadocs 

Acabo de encontrar lo siguiente en un manual de laboratorio en la universidad: Es necesario estudiar las interfaces de las clases generando el javadoc para ellas para que sepa qué operaciones se proporcionan (siéntase libre de mirar el código, pero cuando use el código de otra persona, como aquí, debe …

8 source-code  comments  javadocs 

¿Cuál sería una buena alternativa a la documentación en línea de Java, es decir, puede uno tener un archivo de documentos separado de alguna manera asignado a un archivo fuente de Java? Nunca me han gustado las grandes secciones de comentarios llenas de código.

8 java  documentation  javadocs