簡單介紹 C# 的 yield return

情境:
找出 1 到 n 的整數中被 x 整除的數

第一版 C# 程式碼

private static void OutputFor1(int max, int divisible)
{
 for (int currentNum = 1; currentNum ＜= max; currentNum++)
 {
  if (currentNum % divisible != 0)
  {
   continue;
  }
  System.Console.Write($"{currentNum} ");
 }
 System.Console.WriteLine();
}

第一版修改原因：
1.每行顯示一個數字
2.邏輯改成被 x 乘於二整除的數

private static void OutputFor2(int max, int divisible)
{
 //
 // 某數的2倍整除 & 顯示由上而下
 //
 #region 說明
 // 改變顯示方式及運算邏輯時都改動這段程式碼
 // 違反「單一職責」
 #endregion 說明
 int numMultiplyByTwo_ = divisible * 2;
 for (int currentNum = 1; currentNum ＜= max; currentNum++)
 {
  //if (currentNum % num != 0)
  if (currentNum % numMultiplyByTwo_ != 0)
  {
   continue;
  }
  //System.Console.Write($"{currentNum} ");
  System.Console.WriteLine($"{currentNum} ");
 }
 System.Console.WriteLine();
}

針對違反「單一責任」對程式碼進行優化

private static void OutputForeachList(int max, int divisible)
{
 foreach (int item in EnumerableList(max, divisible))
 {
  System.Console.WriteLine($"{item} ");
 }
 System.Console.WriteLine();
}

private static IEnumerable EnumerableList(int max, int divisible)
{
 List result_ = new List();

 for (int currentNum = 1; currentNum ＜= max; currentNum++)
 {
  System.Console.WriteLine($"讀取{currentNum} ");
  if (currentNum % divisible != 0)
  {
   continue;
  }
  result_.Add(currentNum);
 }
 return result_;
}

雖然執行結果正確，但是會發現一個效能問題。
EnumerableList(50, 2) 會無條件跑完 1 到 50
OutputForeachList 會跑 2,4,6...50
但是 OutputFor2(50, 2) 最多只會跑 50 次
雖然提升了維護性
為了效能
只好再對程式碼再進行一次優化

private static void OutputForeachList2(int max, int divisible)
{
 foreach (int item in EnumerableYield(max, divisible))
 {
  System.Console.WriteLine($"{item}");
 }
 System.Console.WriteLine();
}

private static IEnumerable EnumerableYield(int max, int divisible)
{
 for (int currentNum = 1; currentNum ＜= max; currentNum++)
 {
  System.Console.WriteLine($"讀取：{currentNum} ");
  if (currentNum % divisible != 0)
  {
   continue;
  }
  yield return currentNum;
 }
}

程式碼在遇到 yield return
會暫時停止 EnumerableYield 的執行
並把 currentNum 回傳到 OutputForeachList2 函式
等 OutputForeachList2 結束一個迴圈
會再次回到 EnumerableYield 函式
繼續之前的執行 EnumerableYield 函式

總結：
一般程式碼會執行到函式結束才回到上一層的函式呼叫層
yield return 能打破這個限制
暫時交出執行權
並回傳資料到上一層