如何写出清晰简洁的代码（通过一个实际的案例说明）

本文链接：https://blog.csdn.net/hebhljdx/article/details/140344826

在软件开发中，清晰和简洁的代码是项目长期健康的关键。易读的代码不仅便于维护，还能减少错误的发生。通过分析一个具体的代码示例，我们来探讨如何提升代码的可读性和简洁性。

案例分析

最近，我们在代码审查时，遇到了以下C++代码片段：

void SomeFunction() {
    m_queryCollection++;
    core::post::ToMain(this, [this]() {
        if (m_queryCollection == 0) {
            return;
        }

        // 具体的业务逻辑...
        // 此处省略...
        m_queryCollection = 0;
    });
}

这段代码看了半天也没看懂要干啥，最后跟开发者沟通后才明白，该代码的目标是在消息循环中多次调用SomeFunction函数，但只执行一次业务逻辑。
恍然大悟后，开始反思为什么这段代码这么难懂。主要是该实现引入了几个问题：

问题1：变量命名不清晰。 m_queryCollection并没有清楚地说明其作用。它给人的印象是用于收集查询次数，而不是控制函数调用流程。
问题2：类型选择引起歧义。 m_queryCollection用的是int类型，但其实际上只用于表示两个状态：已发起或未发起。这里是主要的歧义点，如果使用bool类型会更恰当。
问题3：逻辑不明确。 递增m_queryCollection与检查它是否为0的行为相矛盾。这样的代码不直观，难以理解其真正意图。
问题4：性能不佳。 如果SomeFunction被循环调用多次，会导致大量任务被添加到消息队列中，这会导致性能问题。而且这也是导致无法理解代码的关键点之一。刚开始没理解为什么每次都要post。

改进建议

这段代码打回去，让开发重新优化。我们也给出了优化建议，建议优化为如下结构：

void SomeFunction() {
    if (m_hasPosted) {
        return;
    }
    m_hasPosted = true;
    core::post::ToMain(this, [this]() {
        m_hasPosted = false;
        // 具体的业务逻辑
    });
}