如何处理大量的FIXME / TODO注释

问题描述 投票:0回答:1

当前正在研究一个相当老的项目,并且其中包含很多FIXME / TODO注释。我想知道是否有一个很好的方法来处理它。

首先,我想获得可见性会很好,所以将其转换为票证。在此转换过程中,也许可以删除一些评论,因为它们指出的问题已解决,但忘记了删除评论。

第二步,在构建管道中激活FIXME / TODO断路器,因此不会创建新的断路器。

但是现在-最好的方法是/从这里继续的最好方法是什么?

architecture code-cleanup legacy-code
1个回答
0
投票

FIXME和TODO的主要问题是,它变老了,您将需要花费时间来分析它们中的每一个,并确定是否有意义。弄清楚编写什么内容并创建场景以对其进行测试是一项挑战,而且非常耗时。

将FIXME / TODO迁移到票证只会将问题转移到另一个级别。当FIXME很明显并且代表一个清晰的BUG时,在这种情况下,需要创建票证。与TODO相同。

没有简单的解决方案,但是我认为必须执行两个步骤:

  1. 决定如何处理当前的FIXME / TODOS:由于需要时间和资源来处理当前的FIXME / TODOS,因此始终取决于其处理方法,有时还涉及一项业务决策。您可以一一决定,删除或分析它,并决定每种情况该如何处理。如果您决定进行分析,则可以用OLD_FIXME搜索并替换FIXME,而用OLD_TODO搜索并替换TODO,并开辟一条路以正确的方式使用新的FIXME / TODO。
  2. 开始以正确的方式使用FIXME / TODOS。:不允许使用FIXME / TODOS进行代码。在开发过程中添加代码检查步骤,当有人添加此指令时,应在代码成为主代码之前做出决定。
© www.soinside.com 2019 - 2024. All rights reserved.