Never：不曾发生过，亦不将发生

2023-09-24 18:18:07

从「从未发生」到「容易出错」：Never 注释的双面刃

在编程世界中，「Never」是一个看似矛盾的术语。它表示一种不可能发生的事件，但当它出现在代码注释中时，却可能成为一种隐藏的陷阱。本文将深入探讨 Never 注释的由来、用途、潜在风险和最佳实践，帮助程序员充分理解和使用这一复杂且微妙的概念。

Never 注释的由来：提醒和警告

Never 注释最初是由程序员使用的一种便签，旨在提醒他们自己或他人代码中的逻辑错误。例如，在计算数学期望的代码中，如果没有对输入进行边界检查，代码可能会在输入为 0 时出现除以零错误。为了避免这种情况，程序员可能会添加一个 Never 注释：

// Never: n must be greater than 0
double compute_expectation(int n) {
  ...
}

这个注释提醒读者，n 必须大于 0，否则代码将无法正常运行。

编译原理中的 Never 注释：一种优化工具

在编译原理中，Never 注释被视为一种特殊类型的注释，它告诉编译器这段代码永远不会执行。编译器在遇到 Never 注释时，会将其忽略，不会将其编译成机器指令。这使得 Never 注释成为一种非常有用的工具，它可以帮助编译器优化代码，提高程序的运行效率。

例如，如果一段代码检查一个变量是否小于 0，并且永远不可能小于 0，则可以添加一个 Never 注释来告诉编译器这一点。这样，编译器就可以跳过检查，从而提高程序的运行速度。

if (n < 0) {
  // Never: This branch will never be executed
  return 0;
}

Never 注释的陷阱：潜在的错误根源

虽然 Never 注释在某些情况下非常有用，但它也可能引发错误。以下是一些常见的原因：

容易被忽视或修改： 程序员可能会忘记添加 Never 注释，或者在代码审查时没有注意到它。这可能会导致编译器将 Never 注释视为普通注释，并将其编译成机器指令，从而在运行时发生错误。
含义容易被误解： Never 注释的含义可能会被误解，从而导致程序员做出错误的决策。例如，程序员可能会认为 Never 注释表示这段代码永远不会执行，因此可以将其删除。然而，事实并非如此，这段代码可能在某些情况下执行。这样，当程序运行到这段代码时，就会发生错误。
干扰代码理解： 过多或不必要的 Never 注释会干扰代码的可读性和可理解性。程序员在阅读代码时可能会被这些注释分散注意力，从而难以理解代码的逻辑流。

最佳实践：谨慎使用 Never 注释

为了避免 Never 注释引发问题，程序员可以遵循以下最佳实践：