时间戳

首页 > 解决方案 > 重命名类时应该对 javadoc 进行哪些更改？

java - 重命名类时应该对 javadoc 进行哪些更改？

问题描述

假设我有一个班级，我将其重命名。我应该如何更改课程的文档？这就是当前类的 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)
 */

标签： javajavadoc

解决方案

如果更改仅影响类的名称，则只需相应替换文档、配置和其他引用中出现的名称。由于 JavaDoc 不包含任何类名，因此在该特定位置没有什么可做的。

像 IntelliJ 或 Eclipse 这样的 IDE 在进行这样的重构时可以提供很多帮助，因为它们提供了以安全方便的方式执行替换的工具。在简单的情况下，具有搜索和替换功能的文本编辑器可能就足够了。

自动替换后，我会手动完成所有更改并仔细检查它们是否具有预期的影响，因为有时上下文也会受到更改的影响并且需要进行调整。

推荐阅读