Java模式

Question

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

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

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

Answer 1

我不认为这有用。您有充分的理由重构代码，因此开发人员只知道新代码，就不应该使用旧的体系结构。熟悉旧代码的开发人员只知道在新代码中的位置，他们必须寻找javadoc，一旦知道了，他们就不再需要它了。因此，他们需要一个独立于javadoc的迁移指南。

关于最后一个问题，如果API用户不应该看到特定的文档，那么常规的注释作为维护人员来查看源代码--注释--是正确的。