Java 文档模式

Question

我通过将一些方法移动到不同的类来重构一个类。由于这就像架构重构而不是代码重构，我想知道在新类的 javadoc 中提及它包含从以前存在的 X 类移动的方法是否是一个好习惯？例如

/**设置支付组顺序的处理器。该处理器已作为 checkout 重构项目的一部分添加，并且 xxxMethod() 方法已从 {@link XXXFormHandler} 移至此管道处理器。**/

我喜欢这种方法，因为它为参与维护此代码的任何开发人员提供了清晰的画面。我唯一担心的是，如果这作为 API 公开，那么这些信息将显示给所有人。

Answer 1

我认为这没有用。您有充分的理由重构代码，因此只知道新代码的开发人员不应为旧架构而烦恼。只知道旧代码的开发人员不知道他们必须在新代码中的何处查找该 javadoc，一旦他们知道，他们就不再需要它了。因此他们需要一个独立于 javadoc 的迁移指南。

关于最后一个问题，如果 API 用户看不到特定文档，则常规注释会做正确的事情，因为维护者看到源代码会看到注释。