Обеспечение устойчивости JavaDoc к рефакторингу - PullRequest
12 голосов
/ 12 сентября 2011

Я работаю над приложением, которое постоянно подвергается рефакторингу для его улучшения.Теперь, если мы переименуем определенный класс, чтобы лучше уловить его намерения, вся документация, в которой упоминается класс, не обновляется автоматически, если вы не используете ссылки ({@link ClassName}) для ссылки на класс.

Однако в принципах JavaDoc следует «экономно использовать встроенные ссылки», поскольку ссылки выделяются и привлекают внимание читателей, что я считаю разумным.Также вы не можете ссылаться на параметры метода.

Есть ли другой способ в JavaDoc сделать комментарии более устойчивыми к рефакторингу, о котором я не знаю?

1 Ответ

5 голосов
/ 13 сентября 2011

При использовании eclipse для рефакторинга вы также можете искать по строковым ссылкам в таких файлах, как XML-файлы.

Нажмите Shift-Alt-R дважды , чтобы открыть диалоговое окно.(На Mac это Option-Command-R дважды )

...