12
Pracuję nad aplikacją, która jest stale refaktoryzowana, aby ją poprawić. Teraz, jeśli zmienimy nazwę pewnej klasy, aby lepiej uchwycić jej intencje, cała dokumentacja dotycząca tej klasy nie zostanie automatycznie zaktualizowana, chyba że użyjesz linków ({@link ClassName}), aby odnieść się do klasy.Dokonywanie JavaDoc solidne przeciwko refaktoryzacji
Zasady JavaDoc mówią jednak, że należy "używać linków w sposób ekonomiczny", ponieważ linki wyróżniają się i przyciągają uwagę czytelników, co uważam za rozsądne. Ponadto nie można łączyć z parametrami metody.
Czy istnieje inny sposób w JavaDoc, aby komentarze były bardziej odporne na refaktoryzację, o których nie wiem?
W jaki sposób refaktoryzujesz? Podczas zmiany nazwy w Eclipse dostępna jest opcja wyszukiwania komentarzy. –
Tak, używam Eclipse i pamiętam, że to widziałem. Nie mam jednak opcji (używając Ctrl + Alt + R) i nie mogę znaleźć niczego w ustawieniach, aby to zmienić. W każdym razie, to by działało najczęściej, ale może oczywiście być niejednoznaczne. – alexsb
IntelliJ wyszukuje komentarze, ciągi i pliki, aby znaleźć rzeczy do zmiany nazwy. Oferuje również zmianę nazwy pola, zmiennych i parametrów. Zakładam, że Eclipse robi to samo. –