yield¶

先贴一段官方的描述，可以跳过直接看总结的部分。

官方描述¶

在语句中使用 yield 上下文关键字时，表明它出现的方法、运算符或 get 访问器是迭代器。当您为自定义集合类型实现 IEnumerable 和 IEnumerator 模式时，使用 yield 定义迭代器无需显式的额外类。

下面给出了yield语句使用的两个格式：

yield return <expression>;
yield break;

迭代器方法和 get 访问器¶

迭代器的声明必须满足以下要求：

• 返回类型必须为下列类型之一：

  • IAsyncEnumerable<T>
  • IEnumerable<T>
  • IEnumerable
  • IEnumerator<T>
  • IEnumerator

• 声明不能有任何 in、ref 或 out 参数。

异常处理¶

不能将 yield return 语句置于 try-catch 块中。 可将 yield return 语句置于 try-finally 语句的 try 块中。

可将 yield break 语句置于 try 块或 catch 块中，但不能将其置于 finally 块中。

如果 foreach 或 await foreach 主体（在迭代器方法之外）引发异常，则将执行迭代器方法中的 finally 块。

总结¶

yield return 主要用来返回迭代器中的元素，简单的说，可以写一个复杂的方法来生成一个集合用于迭代，但并不是直接生成完整的一个集合，而是每次取下一个元素时，接着从上一次执行的位置接着执行。

void Run()
{
    IEnumerable<int> elements = MyIteratorMethod();
    foreach (int element in elements)
    {
        // ...
    }
}

IEnumerable<int> MyIteratorMethod()
{
    yield return 1;

    // ... 做一些别的操作

    yield return 2;
}

普通创建迭代器一般会有类似于hasNext和moveNext这两个方法，然后每次迭代都会完整的去执行这两个方法。相比之下，这里提供的 yield 关键字创建迭代器会更灵活一点，不需要模板式的提取下一个元素，甚至可以直接自己写一些常量值进去。