1

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

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

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

4

1 回答 1

0

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

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

于 2013-10-21T21:37:14.397 回答