我通过将一些方法移动到不同的类来重构一个类。由于这就像一个架构重构而不是代码重构,我想知道在新类的javadoc中提及它包含从以前存在的X类移出的方法是否是一个好习惯?例如
/ ** 将序列设置为付款组的处理器。此处理器已添加为checkout重构项目的一部分,xxxMethod()方法已从{@link XXXFormHandler}移至此管道处理器。 ** /
我喜欢这种方法,因为它为参与维护此代码的任何开发人员提供了清晰的图像。我唯一担心的是,如果将其作为API公开,那么这些信息将向所有人显示。
答案 0 :(得分:0)
我不认为这有用。你有充分的理由重构代码,所以开发人员只知道新代码不应该打扰旧的架构。知道旧代码的开发人员不知道他们必须在新代码中查找javadoc的位置,一旦他们知道,他们就不再需要它了。所以他们需要一个独立于javadoc的迁移指南。
关于最后一个问题,如果API用户不会看到特定的文档,那么定期评论会做正确的事情,因为维护者看到源代码会看到评论。