c# - 清理病态嵌套 "if { } else { if { } else { if { ... } } }"

Question

我目前不幸在处理其他人的 C# 代码，这让我大吃一惊。我不知道我之前的人是如何维护这段代码的，因为它的各种病症已经使 IDE、编译器、运行时环境崩溃......

我今天面临的问题涉及一个 15 兆字节的源文件，该文件具有真正令人惊叹的病态嵌套程度。代码如下:

if(var == 0) {
  // do stuff
}
else {
  if(var == 1) {
    // do stuff
  }
  else {
    if(var == 2) {
      // do stuff, identical word for word to the `var == 1` case
    }
    else {
      // etc.
    }
  }
}

在最好的情况下，这是一个有问题的风格选择。然而，这与代码的另一种病态相结合:其中一些 block 将近一千级深。 (我费心测量的最深的值远远超过 700。)我真诚地希望我面前的人，作为他们在被迫与此代码分离之前的最后行为之一，运行了一个样式工具，导致了我面前的可憎。我无法想象他们可能会像现在这样编写这段代码，尤其是因为对代码进行的每三次或四次编辑都会使 IDE 崩溃。 (有时会删除我的源文件副本，作为奖励。)

我写了一个简单的基于正则表达式的工具来尝试压缩更简单的案例，但它似乎半处理然后破坏了这个特定的代码。 (我不确定它是否会失败，因为这段代码有时也会使用预处理器条件，或者因为最长的匹配项将近 10MB 长而 Lua 的正则表达式匹配器无法应对。)我希望有可以扭转这个问题的广泛使用的工具或技术。我已经不得不使用 astyle 来清理代码的其他一些风格“问题”。 astyle 的 --remove-brackets 选项 几乎 做我想要的，但要求括号内的语句是一行上的单个语句，这非常不是这里的案例...(只是为了越过我的“t”，我检查了；astyle 没有造成这个特殊问题。)

编辑:对问题代码的深入检查揭示了这样的事情:

#if OneThing
int num2296 = otherThing();
#endif
#if AnotherThing
int num44 = otherThing()
int num45 = 0;
#endif
int num72 = 0;
#if OneThing
int num45 = 0; // note: multiple equivalent declarations of num45
#endif
#if OneThing
for(int num2297 = 0; num2297 < num2296; ++num2297) {
  num45 = doSomething(num2297);
#endif
#if AnotherThing
for(int num43 = 0; num43 < num44; ++num43) {
  num45 = doSomething(num43);
#endif
  if(somethingElse(num45)) {
    ++num72;
  }
} // note: only one closing brace for the two protected by #ifs

此代码的两个版本针对不同目的进行了编译，一个定义了 OneThing，一个定义了 AnotherThing。不过两者的区别大部分只是变量名而已，逻辑完全相同。 (大部分，不是全部。)

上面代码段末尾的大括号等案例解释了为什么我的简单工具坏了。这看起来也越来越像是设计出来的工作保障，而不是无辜的无能。 (如果代码曾经在反编译器会生成像 num2276 这样的变量名的位置，那么当前不在那个位置。)

不幸的是，这意味着自动化工具可能无法独自解决问题。我只需要艰难地完成，慢慢地消除上一个程序员造成的损害。我把这个问题留在这里是因为有一个神奇的工具，我不知道，可以将两个版本转换为 SSA 并识别和折叠它们的逻辑等价物，然后将它们转换回来......

Answer 1

您可以使用 Roslyn 重写代码。将源代码修改为文本不是一个好方法。使用 Roslyn，您可以将其修改为语法树。

也许它可以帮助您将所有内容展平？

if (a)
 if (b) F2()
 else F3();
else
 F4();

可能变成:

if (a && b) F2();
else if (a && !b) F3();
else F4();

这样源代码就变成了一个平面列表，并且在什么条件下进入分支会更加明显。