翻译《有关编程、重构及其他的终极问题？》——42.不要使用“empty”作为函数名

翻译《有关编程、重构及其他的终极问题？》——42.不要使用“empty”作为函数名

标签（空格分隔）：翻译 技术 C/C++
作者：Andrey Karpov
翻译者：顾笑群 - Rafael Gu
最后更新：2018年10月01日

---

42.不要使用“empty”作为函数名

下面的代码片段取自WinMerge项目。该代码包含一个错误，PVS-Studio分析器对这个错误的诊断描述为：V530 The return value of function ‘empty’ is required to be utilized（译者注：大意是说empty函数的返回值应该被使用）。

void CDirView::GetItemFileNames(
  int sel, String& strLeft, String& strRight) const
{
  UINT_PTR diffpos = GetItemKey(sel);
  if (diffpos == (UINT_PTR)SPECIAL_ITEM_POS)
  {
    strLeft.empty();
    strRight.empty();
  }
  ....
}

解释

一个程序员想要清理strLeft和strRight字符串，它们是String类型，其实就是std::wstring。

为此，他调用了empty()函数。这是不正确的。empty()函数不改变对象，只是返回字符串是否为空。

正确的代码

要纠正这个错误，您应该将empty()函数替换为clear()或erase()。WinMerge开发人员喜欢erase()，现在代码是这样的：

if (diffpos == (UINT_PTR)SPECIAL_ITEM_POS)
{
  strLeft.erase();
  strRight.erase();
}

建议

在这种情况下，函数名称“empty()”确实不合适。问题是，在不同的库中，这个函数可能意味着两个不同的操作。

在一些库中，emply()函数清除对象。在另外一些库中，它返回对象是否为空。

我想说的是，“empty”这个词大体上是不太可靠的，因为每个人对它的理解都不一样。一些人认为这是“行动”，另外一些人认为这是“信息查询”。这就是我们觉得其不可靠的原因。

只有一条出路。不要在类名中使用“空”。

• 将用于清理的函数命名为“erase”或“clear”。我比较喜欢用用“erase”，因为“clear”也有可能是比较模糊的。
• 为获取信息的函数使用另一个名称，例如“isEmpty”。

如果你出于某种原因认为这没什么大不了的，那么看看这里。这是一个相当普遍的错误模式。当然，改变诸如std::string这样的类有点晚了，但至少我们不要再传播不好的东西了。