Estoy trabajando en una aplicación que se refactoriza constantemente para mejorarla. Ahora, si cambiamos el nombre de cierta clase para capturar mejor su intención, toda la documentación que menciona la clase no se actualiza automáticamente, a menos que use enlaces ({@link ClassName}) para referirse a la clase.Haciendo que JavaDoc sea robusto contra la refactorización
Los principios de JavaDoc, sin embargo, establecen que uno debe "Utilizar enlaces en línea de forma económica", ya que los enlaces se destacan y atraen la atención de los lectores, lo cual me parece sensato. Además, no puede vincular a los parámetros de un método.
¿Hay alguna otra forma en JavaDoc para hacer comentarios más robustos para la refactorización de los que no tengo conocimiento?
¿Cómo está refactorizando? Al cambiar el nombre en Eclipse, hay una opción para buscar comentarios. –
Sí, uso Eclipse y recuerdo haber visto eso. Sin embargo, no tengo la opción (usando Ctrl + Alt + R), y no puedo encontrar nada en la configuración para cambiar eso. De todos modos, eso funcionaría la mayoría de las veces, pero por supuesto puede ser ambiguo. – alexsb
IntelliJ busca a través de comentarios, cadenas y archivos para encontrar cosas para cambiar el nombre. También ofrece cambiar el nombre del campo, las variables y los parámetros. Supongo que Eclipse hace lo mismo. –