程序员，尤其是系统和库的开发者，为了提高代码的可读性和可维护性，会在注释中使用很多“行话”或专用名词。这些注释就像是作者和未来读者（包括几个月后的自己）之间的一种高效沟通暗号。

// scratch variables 就是一个典型的例子，它简洁地传达了“这是一个为了性能而复用的临时变量”这一信息。

1. 任务/问题追踪类 (Task/Issue Tracking)

这类注释通常是大写，并带有冒号，很多IDE还会对它们进行高亮，方便快速定位。

• // TODO:

  • 含义：待办事项。表示这里有一个功能还没实现，或者有一个已知的改进点需要后续完成。
  • 示例：// TODO: Add support for UDP protocol.

• // FIXME:

  • 含义：修理我。表示这里的代码存在已知的BUG，或者实现方式不正确，需要立即或尽快修复。它的紧急程度通常高于 TODO。
  • 示例：// FIXME: This linear search is too slow, causing performance issues under high load.

• // HACK:

  • 含义：黑客手法/取巧的办法。表示这里的实现是一个临时的、不够优雅的、甚至是“脏”的解决方案，只是为了让功能先跑起来。它暗示这段代码未来应该被重构。
  • 示例：// HACK: Hardcoded timeout value of 5 seconds. Should be configurable.

• // XXX:

  • 含义：警告/有问题。这是一个强烈的警示信号，表示这里的代码虽然能工作，但可能有隐藏的危险、逻辑模糊或者实现非常丑陋，需要特别注意。
  • 示例：// XXX: The third-party library here has a memory leak, be careful.

2. 设计/架构思想类 (Design/Architecture)

这类注释用来解释代码背后的设计模式或核心思想。

• // RAII (Resource Acquisition Is Initialization)

  • 含义：资源获取即初始化。这是C++最重要的思想之一。注释中出现它，是在强调某个类的设计利用了 RAII 原则来自动管理资源（如内存、锁、文件句柄）。
  • 示例：// This class uses RAII to ensure the mutex is always released. (比如 std::lock_guard 的实现)

• // PIMPL (Pointer to Implementation) Idiom

  • 含义：指向实现的指针。当你在头文件中看到一个类只有一个私有的、指向另一个未定义结构体的智能指针时，很可能就是在使用这种手法。它能隐藏实现细节，降低编译依赖。
  • 示例：

    class MyWidget {
    private:
        // PIMPL Idiom
        struct Impl;
        std::unique_ptr<Impl> pimpl_;
    };
    

• // Guarded by (mutex_name)

  • 含义：由（某个锁）保护。这是多线程编程中极其重要的注释。它明确地指出某一个共享数据成员是由哪一个互斥锁来保护的，防止开发者在访问时忘记加锁。
  • 示例：std::vector<int> shared_queue_; // Guarded by queue_mutex_

3. 性能/优化相关 (Performance/Optimization)

这类注释解释了某些代码写法的性能考量。

• // Hot Path

  • 含义：热点路径。指程序中执行得极其频繁的代码路径，这些地方的任何微小性能损耗都会被放大，因此需要高度优化。// scratch variables 通常就出现在热点路径上。

• // Cold Path

  • 含义：冷路径。与热点路径相对，指很少被执行的代码路径，比如错误处理、一次性的初始化代码等。这些地方的代码通常优先考虑可读性和正确性，而非极致性能。

• // scratch variables

  • 含义：指在编程或数据处理中临时使用的变量，主要用于存储中间结果、临时计算值或辅助完成某个特定操作，通常在完成其作用后就不再需要。
  • 这类变量的特点是：
    作用范围较窄（可能仅在某个函数、循环或代码块内有效）；
    生命周期短，完成特定任务后就可能被丢弃或覆盖；
    目的是简化逻辑，避免重复计算或临时存储中间值。

• // Zero-Copy

  • 含义：零拷贝。在网络或IO编程中，指数据在不同内存区域（如内核缓冲区和用户缓冲区）之间转移时，避免了不必要的CPU拷贝操作，以提升吞吐量。

4. 警告/陷阱提示 (Warnings/Pitfalls)

这类注释用来警告读者注意一些C++语言的特性或潜在的坑。

• // UB (Undefined Behavior)

  • 含义：未定义行为。指代码的行为是C++标准未定义的，编译器可以做任何处理，从正常运行到程序崩溃都有可能。这是最危险的BUG来源。
  • 示例：// UB: Dereferencing a null pointer here if condition fails.

• // Race Condition

  • 含义：竞态条件。指多个线程在没有同步的情况下访问共享资源，最终结果取决于线程执行的时序，导致行为不可预测。

• // Re-entrancy / // Thread-safe

  • 含义：可重入性/线程安全。注释会说明一个函数是否是线程安全的，或者是否是可重入的（一个更强的保证）。这对于库函数的使用者来说至关重要。