Создание javadoc устойчиво к рефакторирующему

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

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

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

12
задан alexsb 13 August 2012 в 08:42
поделиться