C ++中方法返回的编码约定

Question

我已经观察到，成功完成方法预期功能的通用编码约定为0。（与exit（0）中一样）。

这种困惑使我感到困惑，因为如果我的if语句中有方法并且方法返回0，则“ if条件”为假，从而促使我想一想该方法已失败。 我当然知道我必须在后面加上“！” （就像在if（！Method（））中一样），但是这种约定本身并不矛盾吗？

Answer 1

您需要区分错误代码和错误标志。 代码是代表任何数量的错误的数字，而标志是表示成功的布尔值。

对于错误代码，其思想是：只有一种成功的方法，但是有许多失败的方法。 用0作为一个好的唯一唯一数字，代表成功，那么您拥有其他所有数字都是表示失败的一种方式。 （这没有其他意义。）

对于错误标志，想法很简单：true表示有效，false表示无效。 通常，您通常可以通过其他方式获取错误代码，并采取相应的措施。

有些功能使用错误代码，有些使用错误标志。 除非您试图将所有内容都视为标志，否则没有任何混淆或倒退。 并非所有的返回值都是一个标志，这只是您必须习惯的东西。

请记住，在C ++中，您通常会处理带有异常的错误。 无需查找错误代码，而只是从捕获的异常中获取必要的信息。

Answer 2

约定本身并不矛盾，它与您对函数的期望使用相矛盾。

其中之一必须改变，这不会成为惯例；-)

我通常会写：

if (Function() == 0) {
    // code for success
} else {
    // code for failure
}

或if (Function() != 0)与情况相反。

可以将整数隐式转换为布尔值，但这并不意味着您总是应该这样做。 这里的0表示0 ，并不表示false 。 如果确实愿意，可以编写：

int error = Function();
if (!error) {
    // code for success
} else {
    // code for failure, perhaps using error value
}

Answer 3

我在代码中使用了这个约定：

int r = Count();

if(r >= 0) {
   // Function successful, r contains a useful non-negative value
}
else {
   // A negative r represents an error code
}

我倾向于避免使用布尔返回值，因为它们没有优势（甚至不考虑其大小（四舍五入为一个字节）），并且限制了函数返回值的可能扩展。

使用异常之前，请考虑它们带来的性能和内存问题。

Answer 4

约定多种多样，但是C函数最常见的是在失败时返回0，在成功时返回正值，因此您可以在if语句中使用它（几乎所有CPU都有条件跳转，可以测试值是否为0）这就是为什么在C中用0表示“ false”表示“滥用”，其他表示true的原因）。

另一个约定是在错误时返回-1，而在成功时返回其他值（特别是在errno变量的POSIX函数中看到了这一点）。 这就是0可以解释为“成功”的地方。

然后有exit 。 这是不同的，因为返回的值不是由C解释，而是由Shell解释。 在这里，值0表示成功，而其他每个值都表示错误情况（许多工具告诉您此值发生了哪种类型的错误）。 这是因为在外壳程序中，返回有意义的值通常只有0-127的范围（历史原因，这是一个无符号字节，大于127的所有内容均表示被某些IIRC信号杀死）。

Answer 5

您已将问题标记为[c] 和 [c++] 。 哪有 因为答案会有所不同。

你说：

我观察到，成功完成方法预期功能的通用编码约定为0。

对于C，这很好。

对于C ++，绝对不是 。 C ++具有另一种发出故障信号的机制（即异常）。 滥用（数字）返回值通常表示设计不良。

如果由于某些原因无法执行异常，则可以使用其他方法来发出失败信号，而不会阻塞方法的返回类型。 替代方法包括返回bool （考虑方法try_insert ）或使用无效/保留的失败返回值，例如string::find方法使用的string::npos ，如果在string::find未发现任何情况。

Answer 6

exit（0）是一个非常特殊的情况，因为它是一个哨兵值，要求编译器告诉操作系统返回该OS上真正成功的值。 完全有可能不是数字0。

如您所说，许多函数返回0表示成功，但它们主要是“旧式” C库OS接口函数，并且遵循最初开发和部署C的操作系统的接口样式。

因此，在C ++中，包装此类C传统接口时，成功值可能为0。 您可能会考虑使用0成功的另一种情况是，当您有效地返回错误代码时，即所有错误均为非零值，而0表示非错误值。 因此，不要将返回值视为布尔值（即使C ++会将其隐式转换为1），而是将其视为错误代码，其中0表示“无错误”。 （实际上，最好使用枚举）。

仍然，您通常应该从某种形式的谓词（例如is_empty（），has_dependencies（），can_fit（）等）的函数中返回布尔值，并且通常在错误时引发异常。 或者，按照libc的errno为错误代码使用子系统（可能是线程）特定的值，或者接受要加载错误代码的变量的单独引用/指针参数。

Answer 7

int retCode = SaveWork();

if(retCode == 0) {
  //Success !
} else if(retCode == ERR_PERMISSIONS) {
  //User doesn't have permissions, inform him
  //and let him chose another place
} else if(retCode == ERR_NO_SPACE) {
  //No space left to save the work. Figure out something.
} else {
    //I give up, user is screwd.
}

因此，如果将0 / false返回到平均失败，则无法区分错误的原因。 对于C ++，您可以使用异常来区分不同的错误。 您还可以使用类似于errno的全局变量，在发生故障时检查该变量。 当既不需要异常也不需要全局变量时，通常使用返回错误代码。

Answer 8

正如其他答案已经说过的那样，使用0表示成功会使所有内容都不为零。 通常（尽管不是总是），这意味着使用单个非零值来指示故障的类型。 就像已经说过的那样，在这种情况下，您必须将其视为错误代码而不是成功/失败标志。

在这种情况下，我绝对讨厌看到类似if(!Method())这样的语句，它实际上是对成功的测试。 对于我自己来说，我也发现它可能引起一时的疑惑，即该语句是否正在测试成功或失败。 在我看来，由于它不是简单的布尔返回值，因此不应将其写成这样。

理想情况下，由于将返回值用作错误代码，因此该函数的作者应该提供可以代替原始数字使用的枚举（或至少一组定义）。 如果是这样，那么我总是喜欢将测试重写为类似if(Method() == METHOD_SUCCESS) 。 如果作者没有提供，但是您有关于错误代码值的文档，请考虑制作自己的枚举或定义并使用它。

如果没有别的，我将其写为if(Method() == 0)因为这样至少读者仍然应该明白Method不会返回简单的布尔值，并且零具有特定含义。

---

尽管经常使用该约定，但它当然不是唯一的约定。 我已经看到了使用正值和负值来区分成功和失败的约定。 当函数在成功时返回计数但在失败时需要返回不是值计数的值（通常为-1）时，尤其会发生这种情况。 我也看到了使用无符号数字的变体，其中(unsigned int)-1 （aka 0xffffffff）表示错误。 而且可能还有其他我什至无法想到的东西。

由于没有唯一正确的方法来执行此操作，因此不同时期的不同作者已经发明了各种方案。

当然，这一切都没有提到，当函数有错误时，异常（除其他外）提供了一种完全不同的信息提供方式。