重命名類時應該對 javadoc 進行哪些更改？

Question

假設我有一個課程，我將其重命名。 我應該如何更改課程的文檔？ 這是當前類的 javadoc 的樣子

/**
 * Single report.
 *
 * <p>There is no thread-safety guarantee.
 *
 * @author Yegor Bugayenko (yegor256@gmail.com)
 * @version $Id: 532ae3783f6bcb7ffa6819b91ebee78670aa82e3 $
 * @since 0.1
 * @checkstyle ClassDataAbstractionCouplingCheck (500 lines)
 * @checkstyle JavadocTagsCheck (500 lines)
 */

Answer 1

如果更改僅影響類的名稱，則僅需要相應替換文檔、配置和其他引用中出現的名稱。 因為 JavaDoc 不包含任何類名，所以在那個特定的地方沒有什么可做的。

像 IntelliJ 或 Eclipse 之類的 IDE 在進行此類重構時可以提供很多幫助，因為它們提供了以安全便捷的方式執行替換的工具。 在簡單的情況下，具有搜索和替換功能的文本編輯器可能就足夠了。

自動替換后，我會手動完成所有更改並仔細檢查它們是否具有預期的影響，因為有時上下文也會受到更改的影響並且需要進行調整。