重命名 class 时应对 javadoc 进行哪些更改?
What changes to javadoc should be made when renaming a class?
说我有一个 class,我给它重命名了。
我应该如何更改 class 的文档?
这就是 class 的 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)
*/
如果更改仅影响 class 的名称,则只需相应地替换文档、配置和其他参考中出现的名称。由于 JavaDoc 不包含任何 class 名称,因此在该特定位置无事可做。
IDE 之类的 IntelliJ 或 Eclipse 在进行此类重构时可以提供很多帮助,因为它们提供了以安全便捷的方式执行替换的工具。在简单的情况下,具有搜索和替换功能的文本编辑器可能就足够了。
自动替换后,我会手动检查所有更改,并仔细检查它们是否具有预期的影响,因为有时上下文也会受到更改的影响,需要进行调整。
说我有一个 class,我给它重命名了。 我应该如何更改 class 的文档? 这就是 class 的 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)
*/
如果更改仅影响 class 的名称,则只需相应地替换文档、配置和其他参考中出现的名称。由于 JavaDoc 不包含任何 class 名称,因此在该特定位置无事可做。
IDE 之类的 IntelliJ 或 Eclipse 在进行此类重构时可以提供很多帮助,因为它们提供了以安全便捷的方式执行替换的工具。在简单的情况下,具有搜索和替换功能的文本编辑器可能就足够了。
自动替换后,我会手动检查所有更改,并仔细检查它们是否具有预期的影响,因为有时上下文也会受到更改的影响,需要进行调整。