programa - javadoc pdf

¿Cómo modifico el Javadoc cuando modifico el código de otra persona?

Question

Estoy trabajando en el código de otra persona y haciendo modificaciones significativas. (Lo estoy convirtiendo para usar una base de datos diferente a la que usó originalmente). ¿Cómo indico en los comentarios de Javadoc que no soy el autor original del código, pero que sí contribuí? ¿Hay una manera limpia o estándar de hacer esto ya? Mi Google no me está ayudando a resolver esto.

Ejemplo:

/**
* This class does some really awesome stuff.
* 
* @author Steph the Great - Modified to use PostgreSQL instead of Derby;
*         added comments to the code
*/

Tampoco sé el nombre del autor original, por lo que todo lo que puedo escribir es a mí mismo. . .

Answer 1

Esos comentarios no pertenecen al javadoc :-) El javadoc debe explicar el contrato, es lo que se extrae y se muestra en la "documentación" generada automáticamente. El resto son solo comentarios normales o, quizás mejor aún, en este caso, las entradas de registro de SCM y no tienen lugar en el javadoc.

Probablemente dejaría el autor original, pero si quieres crédito ...

... vea la referencia de @author javadoc y tenga en cuenta que puede incluirse varias veces. Esta sección se relaciona explícitamente con múltiples autores y pedidos, etc.

/**
* This class does some really awesome stuff.
* It uses PostreSQL. 
*
* @author Steph the Great
* @author Freddy Four Fingers
*/
// DEC2012 - Fred - Modified to use PostgreSQL instead of Derby (but really, use SCM!)
class Awesome { ... }

Feliz codificacion

Notas sobre la pregunta de alguna manera no relacionadas con el ejemplo en la publicación ... si el autor no es conocido, entonces se pueden hacer varias cosas. En primer lugar, agregue un enlace o una referencia al lugar donde se obtuvo la fuente original; también se puede anotar un "No escribí esto originalmente" opcional para mayor claridad.

Luego, dependiendo de su preferencia:

1. No especifique un campo @author , ni siquiera usted mismo. No es necesario.
2. Súmate como el único autor; La fuente original se menciona arriba en el javadoc.
3. Agregue un autor ficticio y usted mismo como segundo autor, por ejemplo, @author Unknown @author unascribed (ver comentarios y @author ).
4. Haz lo que quieras dentro de los términos de la licencia, si los hay.

Answer 2

Puede tener más de una etiqueta @author . Por lo tanto, si ha realizado grandes cambios en una clase, simplemente agregue una nueva etiqueta @author con su propio nombre en ella. No es necesario enumerar los cambios que ha hecho, el historial de revisiones debería mostrarlo lo suficientemente bien.