Help us learn about your current experience with the documentation. Take the survey.

重命名功能

有时业务部门要求更改功能名称。 broadly speaking,有 2 种方法可以完成这项任务。它们基本上是在即时工作量和未来复杂性/bug 风险之间进行权衡:

  • 完整方式:重命名仓库中的所有内容。
    • 优点:不会增加代码复杂性。
    • 缺点:执行工作量更大,即时 bug 风险更高。
  • 门面方式:尽可能少地重命名;只重命名面向用户的内容,如接口、 文档、错误消息等。
    • 优点:执行工作量更小。
    • 缺点:增加代码复杂性,导致未来 bug 风险更高。

何时选择门面方式

以下情况越符合,就越应该选择门面方式:

  • 你不确定新名称是永久性的。
  • 该功能容易产生 bug(规模大、复杂、需要重构等)。
  • 重命名难以审查(功能跨越多行、多个文件或多个仓库)。
  • 重命名以某种方式造成干扰(数据库表重命名)。

考虑采用门面优先的方式

门面方式不一定是最终步骤。它可以(而且可能应该)被视为第一步,后续迭代完成完整的重命名。