underscore源码-带中文注解

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
//     Underscore.js 1.8.3
// http://underscorejs.org
// (c) 2009-2015 Jeremy Ashkenas, DocumentCloud and Investigative Reporters & Editors
// Underscore may be freely distributed under the MIT license.
// 中文注释 by hanzichi @https://github.com/hanzichi
// 我的源码解读顺序(跟系列解读文章相对应)
// Object -> Array -> Collection -> Function -> Utility

(function() {

// Baseline setup
// 基本设置、配置
// --------------

// Establish the root object, `window` in the browser, or `exports` on the server.
// 将 this 赋值给局部变量 root
// root 的值, 客户端为 `window`, 服务端(node) 中为 `exports`
var root = this;

// Save the previous value of the `_` variable.
// 将原来全局环境中的变量 `_` 赋值给变量 previousUnderscore 进行缓存
// 在后面的 noConflict 方法中有用到
var previousUnderscore = root._;

// Save bytes in the minified (but not gzipped) version:
// 缓存变量, 便于压缩代码
// 此处「压缩」指的是压缩到 min.js 版本
// 而不是 gzip 压缩
var ArrayProto = Array.prototype, ObjProto = Object.prototype, FuncProto = Function.prototype;

// Create quick reference variables for speed access to core prototypes.
// 缓存变量, 便于压缩代码
// 同时可减少在原型链中的查找次数(提高代码效率)
var
push = ArrayProto.push,
slice = ArrayProto.slice,
toString = ObjProto.toString,
hasOwnProperty = ObjProto.hasOwnProperty;

// All **ECMAScript 5** native function implementations that we hope to use
// are declared here.
// ES5 原生方法, 如果浏览器支持, 则 underscore 中会优先使用
var
nativeIsArray = Array.isArray,
nativeKeys = Object.keys,
nativeBind = FuncProto.bind,
nativeCreate = Object.create;

// Naked function reference for surrogate-prototype-swapping.
var Ctor = function(){};

// Create a safe reference to the Underscore object for use below.
// 核心函数
// `_` 其实是一个构造函数
// 支持无 new 调用的构造函数(思考 jQuery 的无 new 调用)
// 将传入的参数(实际要操作的数据)赋值给 this._wrapped 属性
// OOP 调用时,_ 相当于一个构造函数
// each 等方法都在该构造函数的原型链上
// _([1, 2, 3]).each(alert)
// _([1, 2, 3]) 相当于无 new 构造了一个新的对象
// 调用了该对象的 each 方法,该方法在该对象构造函数的原型链上
var _ = function(obj) {
// 以下均针对 OOP 形式的调用
// 如果是非 OOP 形式的调用,不会进入该函数内部

// 如果 obj 已经是 `_` 函数的实例,则直接返回 obj
if (obj instanceof _)
return obj;

// 如果不是 `_` 函数的实例
// 则调用 new 运算符,返回实例化的对象
if (!(this instanceof _))
return new _(obj);

// 将 obj 赋值给 this._wrapped 属性
this._wrapped = obj;
};

// Export the Underscore object for **Node.js**, with
// backwards-compatibility for the old `require()` API. If we're in
// the browser, add `_` as a global object.
// 将上面定义的 `_` 局部变量赋值给全局对象中的 `_` 属性
// 即客户端中 window._ = _
// 服务端(node)中 exports._ = _
// 同时在服务端向后兼容老的 require() API
// 这样暴露给全局后便可以在全局环境中使用 `_` 变量(方法)
if (typeof exports !== 'undefined') {
if (typeof module !== 'undefined' && module.exports) {
exports = module.exports = _;
}
exports._ = _;
} else {
root._ = _;
}

// Current version.
// 当前 underscore 版本号
_.VERSION = '1.8.3';

// Internal function that returns an efficient (for current engines) version
// of the passed-in callback, to be repeatedly applied in other Underscore
// functions.
// underscore 内部方法
// 根据 this 指向(context 参数)
// 以及 argCount 参数
// 二次操作返回一些回调、迭代方法
var optimizeCb = function(func, context, argCount) {
// 如果没有指定 this 指向,则返回原函数
if (context === void 0)
return func;

switch (argCount == null ? 3 : argCount) {
case 1: return function(value) {
return func.call(context, value);
};
case 2: return function(value, other) {
return func.call(context, value, other);
};

// 如果有指定 this,但没有传入 argCount 参数
// 则执行以下 case
// _.each、_.map
case 3: return function(value, index, collection) {
return func.call(context, value, index, collection);
};

// _.reduce、_.reduceRight
case 4: return function(accumulator, value, index, collection) {
return func.call(context, accumulator, value, index, collection);
};
}

// 其实不用上面的 switch-case 语句
// 直接执行下面的 return 函数就行了
// 不这样做的原因是 call 比 apply 快很多
// .apply 在运行前要对作为参数的数组进行一系列检验和深拷贝,.call 则没有这些步骤
// 具体可以参考:
// https://segmentfault.com/q/1010000007894513
// http://www.ecma-international.org/ecma-262/5.1/#sec-15.3.4.3
// http://www.ecma-international.org/ecma-262/5.1/#sec-15.3.4.4
return function() {
return func.apply(context, arguments);
};
};

// A mostly-internal function to generate callbacks that can be applied
// to each element in a collection, returning the desired result — either
// identity, an arbitrary callback, a property matcher, or a property accessor.
var cb = function(value, context, argCount) {
if (value == null) return _.identity;
if (_.isFunction(value)) return optimizeCb(value, context, argCount);
if (_.isObject(value)) return _.matcher(value);
return _.property(value);
};

_.iteratee = function(value, context) {
return cb(value, context, Infinity);
};

// An internal function for creating assigner functions.
// 有三个方法用到了这个内部函数
// _.extend & _.extendOwn & _.defaults
// _.extend = createAssigner(_.allKeys);
// _.extendOwn = _.assign = createAssigner(_.keys);
// _.defaults = createAssigner(_.allKeys, true);
var createAssigner = function(keysFunc, undefinedOnly) {
// 返回函数
// 经典闭包(undefinedOnly 参数在返回的函数中被引用)
// 返回的函数参数个数 >= 1
// 将第二个开始的对象参数的键值对 "继承" 给第一个参数
return function(obj) {
var length = arguments.length;
// 只传入了一个参数(或者 0 个?)
// 或者传入的第一个参数是 null
if (length < 2 || obj == null) return obj;

// 枚举第一个参数除外的对象参数
// 即 arguments[1], arguments[2] ...
for (var index = 1; index < length; index++) {
// source 即为对象参数
var source = arguments[index],
// 提取对象参数的 keys 值
// keysFunc 参数表示 _.keys
// 或者 _.allKeys
keys = keysFunc(source),
l = keys.length;

// 遍历该对象的键值对
for (var i = 0; i < l; i++) {
var key = keys[i];
// _.extend 和 _.extendOwn 方法
// 没有传入 undefinedOnly 参数,即 !undefinedOnly 为 true
// 即肯定会执行 obj[key] = source[key]
// 后面对象的键值对直接覆盖 obj
// ==========================================
// _.defaults 方法,undefinedOnly 参数为 true
// 即 !undefinedOnly 为 false
// 那么当且仅当 obj[key] 为 undefined 时才覆盖
// 即如果有相同的 key 值,取最早出现的 value 值
// *defaults 中有相同 key 的也是一样取首次出现的
if (!undefinedOnly || obj[key] === void 0)
obj[key] = source[key];
}
}

// 返回已经继承后面对象参数属性的第一个参数对象
return obj;
};
};

// An internal function for creating a new object that inherits from another.
// use in `_.create`
var baseCreate = function(prototype) {
// 如果 prototype 参数不是对象
if (!_.isObject(prototype)) return {};

// 如果浏览器支持 ES5 Object.create
if (nativeCreate) return nativeCreate(prototype);

Ctor.prototype = prototype;
var result = new Ctor;
Ctor.prototype = null;
return result;
};

// 闭包
var property = function(key) {
return function(obj) {
return obj == null ? void 0 : obj[key];
};
};

// Helper for collection methods to determine whether a collection
// should be iterated as an array or as an object
// Related: http://people.mozilla.org/~jorendorff/es6-draft.html#sec-tolength
// Avoids a very nasty iOS 8 JIT bug on ARM-64. #2094

// Math.pow(2, 53) - 1 是 JavaScript 中能精确表示的最大数字
var MAX_ARRAY_INDEX = Math.pow(2, 53) - 1;

// getLength 函数
// 该函数传入一个参数,返回参数的 length 属性值
// 用来获取 array 以及 arrayLike 元素的 length 属性值
var getLength = property('length');

// 判断是否是 ArrayLike Object
// 类数组,即拥有 length 属性并且 length 属性值为 Number 类型的元素
// 包括数组、arguments、HTML Collection 以及 NodeList 等等
// 包括类似 {length: 10} 这样的对象
// 包括字符串、函数等
var isArrayLike = function(collection) {
// 返回参数 collection 的 length 属性值
var length = getLength(collection);
return typeof length == 'number' && length >= 0 && length <= MAX_ARRAY_INDEX;
};


// Collection Functions
// 数组或者对象的扩展方法
// 共 25 个扩展方法
// --------------------

// The cornerstone, an `each` implementation, aka `forEach`.
// Handles raw objects in addition to array-likes. Treats all
// sparse array-likes as if they were dense.
// 与 ES5 中 Array.prototype.forEach 使用方法类似
// 遍历数组或者对象的每个元素
// 第一个参数为数组(包括类数组)或者对象
// 第二个参数为迭代方法,对数组或者对象每个元素都执行该方法
// 该方法又能传入三个参数,分别为 (item, index, array)((value, key, obj) for object)
// 与 ES5 中 Array.prototype.forEach 方法传参格式一致
// 第三个参数(可省略)确定第二个参数 iteratee 函数中的(可能有的)this 指向
// 即 iteratee 中出现的(如果有)所有 this 都指向 context
// notice: 不要传入一个带有 key 类型为 number 的对象!
// notice: _.each 方法不能用 return 跳出循环(同样,Array.prototype.forEach 也不行)
_.each = _.forEach = function(obj, iteratee, context) {
// 根据 context 确定不同的迭代函数
iteratee = optimizeCb(iteratee, context);

var i, length;

// 如果是类数组
// 默认不会传入类似 {length: 10} 这样的数据
if (isArrayLike(obj)) {
// 遍历
for (i = 0, length = obj.length; i < length; i++) {
iteratee(obj[i], i, obj);
}
} else { // 如果 obj 是对象
// 获取对象的所有 key 值
var keys = _.keys(obj);

// 如果是对象,则遍历处理 values 值
for (i = 0, length = keys.length; i < length; i++) {
iteratee(obj[keys[i]], keys[i], obj); // (value, key, obj)
}
}

// 返回 obj 参数
// 供链式调用(Returns the list for chaining)
// 应该仅 OOP 调用有效
return obj;
};

// Return the results of applying the iteratee to each element.
// 与 ES5 中 Array.prototype.map 使用方法类似
// 传参形式与 _.each 方法类似
// 遍历数组(每个元素)或者对象的每个元素(value)
// 对每个元素执行 iteratee 迭代方法
// 将结果保存到新的数组中,并返回
_.map = _.collect = function(obj, iteratee, context) {
// 根据 context 确定不同的迭代函数
iteratee = cb(iteratee, context);

// 如果传参是对象,则获取它的 keys 值数组(短路表达式)
var keys = !isArrayLike(obj) && _.keys(obj),
// 如果 obj 为对象,则 length 为 key.length
// 如果 obj 为数组,则 length 为 obj.length
length = (keys || obj).length,
results = Array(length); // 结果数组

// 遍历
for (var index = 0; index < length; index++) {
// 如果 obj 为对象,则 currentKey 为对象键值 key
// 如果 obj 为数组,则 currentKey 为 index 值
var currentKey = keys ? keys[index] : index;
results[index] = iteratee(obj[currentKey], currentKey, obj);
}

// 返回新的结果数组
return results;
};

// Create a reducing function iterating left or right.
// dir === 1 -> _.reduce
// dir === -1 -> _.reduceRight
function createReduce(dir) {
// Optimized iterator function as using arguments.length
// in the main function will deoptimize the, see #1991.
function iterator(obj, iteratee, memo, keys, index, length) {
for (; index >= 0 && index < length; index += dir) {
var currentKey = keys ? keys[index] : index;
// 迭代,返回值供下次迭代调用
memo = iteratee(memo, obj[currentKey], currentKey, obj);
}
// 每次迭代返回值,供下次迭代调用
return memo;
}

// _.reduce(_.reduceRight)可传入的 4 个参数
// obj 数组或者对象
// iteratee 迭代方法,对数组或者对象每个元素执行该方法
// memo 初始值,如果有,则从 obj 第一个元素开始迭代
// 如果没有,则从 obj 第二个元素开始迭代,将第一个元素作为初始值
// context 为迭代函数中的 this 指向
return function(obj, iteratee, memo, context) {
iteratee = optimizeCb(iteratee, context, 4);
var keys = !isArrayLike(obj) && _.keys(obj),
length = (keys || obj).length,
index = dir > 0 ? 0 : length - 1;

// Determine the initial value if none is provided.
// 如果没有指定初始值
// 则把第一个元素指定为初始值
if (arguments.length < 3) {
memo = obj[keys ? keys[index] : index];
// 根据 dir 确定是向左还是向右遍历
index += dir;
}

return iterator(obj, iteratee, memo, keys, index, length);
};
}

// **Reduce** builds up a single result from a list of values, aka `inject`,
// or `foldl`.
// 与 ES5 中 Array.prototype.reduce 使用方法类似
// _.reduce(list, iteratee, [memo], [context])
// _.reduce 方法最多可传入 4 个参数
// memo 为初始值,可选
// context 为指定 iteratee 中 this 指向,可选
_.reduce = _.foldl = _.inject = createReduce(1);

// The right-associative version of reduce, also known as `foldr`.
// 与 ES5 中 Array.prototype.reduceRight 使用方法类似
_.reduceRight = _.foldr = createReduce(-1);

// Return the first value which passes a truth test. Aliased as `detect`.
// 寻找数组或者对象中第一个满足条件(predicate 函数返回 true)的元素
// 并返回该元素值
// _.find(list, predicate, [context])
_.find = _.detect = function(obj, predicate, context) {
var key;
// 如果 obj 是数组,key 为满足条件的下标
if (isArrayLike(obj)) {
key = _.findIndex(obj, predicate, context);
} else {
// 如果 obj 是对象,key 为满足条件的元素的 key 值
key = _.findKey(obj, predicate, context);
}

// 如果该元素存在,则返回该元素
// 如果不存在,则默认返回 undefined(函数没有返回,即返回 undefined)
if (key !== void 0 && key !== -1) return obj[key];
};

// Return all the elements that pass a truth test.
// Aliased as `select`.
// 与 ES5 中 Array.prototype.filter 使用方法类似
// 寻找数组或者对象中所有满足条件的元素
// 如果是数组,则将 `元素值` 存入数组
// 如果是对象,则将 `value 值` 存入数组
// 返回该数组
// _.filter(list, predicate, [context])
_.filter = _.select = function(obj, predicate, context) {
var results = [];

// 根据 this 指向,返回 predicate 函数(判断函数)
predicate = cb(predicate, context);

// 遍历每个元素,如果符合条件则存入数组
_.each(obj, function(value, index, list) {
if (predicate(value, index, list)) results.push(value);
});

return results;
};

// Return all the elements for which a truth test fails.
// 寻找数组或者对象中所有不满足条件的元素
// 并以数组方式返回
// 所得结果是 _.filter 方法的补集
_.reject = function(obj, predicate, context) {
return _.filter(obj, _.negate(cb(predicate)), context);
};

// Determine whether all of the elements match a truth test.
// Aliased as `all`.
// 与 ES5 中的 Array.prototype.every 方法类似
// 判断数组中的每个元素或者对象中每个 value 值是否都满足 predicate 函数中的判断条件
// 如果是,则返回 ture;否则返回 false(有一个不满足就返回 false)
// _.every(list, [predicate], [context])
_.every = _.all = function(obj, predicate, context) {
// 根据 this 指向,返回相应 predicate 函数
predicate = cb(predicate, context);

var keys = !isArrayLike(obj) && _.keys(obj),
length = (keys || obj).length;

for (var index = 0; index < length; index++) {
var currentKey = keys ? keys[index] : index;
// 如果有一个不能满足 predicate 中的条件
// 则返回 false
if (!predicate(obj[currentKey], currentKey, obj))
return false;
}

return true;
};

// Determine if at least one element in the object matches a truth test.
// Aliased as `any`.
// 与 ES5 中 Array.prototype.some 方法类似
// 判断数组或者对象中是否有一个元素(value 值 for object)满足 predicate 函数中的条件
// 如果是则返回 true;否则返回 false
// _.some(list, [predicate], [context])
_.some = _.any = function(obj, predicate, context) {
// 根据 context 返回 predicate 函数
predicate = cb(predicate, context);
// 如果传参是对象,则返回该对象的 keys 数组
var keys = !isArrayLike(obj) && _.keys(obj),
length = (keys || obj).length;
for (var index = 0; index < length; index++) {
var currentKey = keys ? keys[index] : index;
// 如果有一个元素满足条件,则返回 true
if (predicate(obj[currentKey], currentKey, obj)) return true;
}
return false;
};

// Determine if the array or object contains a given item (using `===`).
// Aliased as `includes` and `include`.
// 判断数组或者对象中(value 值)是否有指定元素
// 如果是 object,则忽略 key 值,只需要查找 value 值即可
// 即该 obj 中是否有指定的 value 值
// 返回布尔值
_.contains = _.includes = _.include = function(obj, item, fromIndex, guard) {
// 如果是对象,返回 values 组成的数组
if (!isArrayLike(obj)) obj = _.values(obj);

// fromIndex 表示查询起始位置
// 如果没有指定该参数,则默认从头找起
if (typeof fromIndex != 'number' || guard) fromIndex = 0;

// _.indexOf 是数组的扩展方法(Array Functions)
// 数组中寻找某一元素
return _.indexOf(obj, item, fromIndex) >= 0;
};

// Invoke a method (with arguments) on every item in a collection.
// Calls the method named by methodName on each value in the list.
// Any extra arguments passed to invoke will be forwarded on to the method invocation.
// 数组或者对象中的每个元素都调用 method 方法
// 返回调用后的结果(数组或者关联数组)
// method 参数后的参数会被当做参数传入 method 方法中
// _.invoke(list, methodName, *arguments)
_.invoke = function(obj, method) {
// *arguments 参数
var args = slice.call(arguments, 2);

// 判断 method 是不是函数
var isFunc = _.isFunction(method);

// 用 map 方法对数组或者对象每个元素调用方法
// 返回数组
return _.map(obj, function(value) {
// 如果 method 不是函数,则可能是 obj 的 key 值
// 而 obj[method] 可能为函数
var func = isFunc ? method : value[method];
return func == null ? func : func.apply(value, args);
});
};

// Convenience version of a common use case of `map`: fetching a property.
// 一个数组,元素都是对象
// 根据指定的 key 值
// 返回一个数组,元素都是指定 key 值的 value 值
/*
var property = function(key) {
return function(obj) {
return obj == null ? void 0 : obj[key];
};
};
*/
// _.pluck(list, propertyName)
_.pluck = function(obj, key) {
return _.map(obj, _.property(key));
};

// Convenience version of a common use case of `filter`: selecting only objects
// containing specific `key:value` pairs.
// 根据指定的键值对
// 选择对象
_.where = function(obj, attrs) {
return _.filter(obj, _.matcher(attrs));
};

// Convenience version of a common use case of `find`: getting the first object
// containing specific `key:value` pairs.
// 寻找第一个有指定 key-value 键值对的对象
_.findWhere = function(obj, attrs) {
return _.find(obj, _.matcher(attrs));
};

// Return the maximum element (or element-based computation).
// 寻找数组中的最大元素
// 或者对象中的最大 value 值
// 如果有 iteratee 参数,则求每个元素经过该函数迭代后的最值
// _.max(list, [iteratee], [context])
_.max = function(obj, iteratee, context) {
var result = -Infinity, lastComputed = -Infinity,
value, computed;

// 单纯地寻找最值
if (iteratee == null && obj != null) {
// 如果是数组,则寻找数组中最大元素
// 如果是对象,则寻找最大 value 值
obj = isArrayLike(obj) ? obj : _.values(obj);

for (var i = 0, length = obj.length; i < length; i++) {
value = obj[i];
if (value > result) {
result = value;
}
}
} else { // 寻找元素经过迭代后的最值
iteratee = cb(iteratee, context);

// result 保存结果元素
// lastComputed 保存计算过程中出现的最值
// 遍历元素
_.each(obj, function(value, index, list) {
// 经过迭代函数后的值
computed = iteratee(value, index, list);
// && 的优先级高于 ||
if (computed > lastComputed || computed === -Infinity && result === -Infinity) {
result = value;
lastComputed = computed;
}
});
}

return result;
};

// Return the minimum element (or element-based computation).
// 寻找最小的元素
// 类似 _.max
// _.min(list, [iteratee], [context])
_.min = function(obj, iteratee, context) {
var result = Infinity, lastComputed = Infinity,
value, computed;
if (iteratee == null && obj != null) {
obj = isArrayLike(obj) ? obj : _.values(obj);
for (var i = 0, length = obj.length; i < length; i++) {
value = obj[i];
if (value < result) {
result = value;
}
}
} else {
iteratee = cb(iteratee, context);
_.each(obj, function(value, index, list) {
computed = iteratee(value, index, list);
if (computed < lastComputed || computed === Infinity && result === Infinity) {
result = value;
lastComputed = computed;
}
});
}
return result;
};

// Shuffle a collection, using the modern version of the
// [Fisher-Yates shuffle](http://en.wikipedia.org/wiki/Fisher–Yates_shuffle).
// 将数组乱序
// 如果是对象,则返回一个数组,数组由对象 value 值构成
// Fisher-Yates shuffle 算法
// 最优的洗牌算法,复杂度 O(n)
// 乱序不要用 sort + Math.random(),复杂度 O(nlogn)
// 而且,并不是真正的乱序
// @see https://github.com/hanzichi/underscore-analysis/issues/15
_.shuffle = function(obj) {
// 如果是对象,则对 value 值进行乱序
var set = isArrayLike(obj) ? obj : _.values(obj);
var length = set.length;

// 乱序后返回的数组副本(参数是对象则返回乱序后的 value 数组)
var shuffled = Array(length);

// 枚举元素
for (var index = 0, rand; index < length; index++) {
// 将当前所枚举位置的元素和 `index=rand` 位置的元素交换
rand = _.random(0, index);
if (rand !== index) shuffled[index] = shuffled[rand];
shuffled[rand] = set[index];
}

return shuffled;
};

// Sample **n** random values from a collection.
// If **n** is not specified, returns a single random element.
// The internal `guard` argument allows it to work with `map`.
// 随机返回数组或者对象中的一个元素
// 如果指定了参数 `n`,则随机返回 n 个元素组成的数组
// 如果参数是对象,则数组由 values 组成
_.sample = function(obj, n, guard) {
// 随机返回一个元素
if (n == null || guard) {
if (!isArrayLike(obj)) obj = _.values(obj);
return obj[_.random(obj.length - 1)];
}

// 随机返回 n 个
return _.shuffle(obj).slice(0, Math.max(0, n));
};

// Sort the object's values by a criterion produced by an iteratee.
// 排序
// _.sortBy(list, iteratee, [context])
_.sortBy = function(obj, iteratee, context) {
iteratee = cb(iteratee, context);

// 根据指定的 key 返回 values 数组
// _.pluck([{}, {}, {}], 'value')
return _.pluck(
// _.map(obj, function(){}).sort()
// _.map 后的结果 [{}, {}..]
// sort 后的结果 [{}, {}..]
_.map(obj, function(value, index, list) {
return {
value: value,
index: index,
// 元素经过迭代函数迭代后的值
criteria: iteratee(value, index, list)
};
}).sort(function(left, right) {
var a = left.criteria;
var b = right.criteria;
if (a !== b) {
if (a > b || a === void 0) return 1;
if (a < b || b === void 0) return -1;
}
return left.index - right.index;
}), 'value');

};

// An internal function used for aggregate "group by" operations.
// behavior 是一个函数参数
// _.groupBy, _.indexBy 以及 _.countBy 其实都是对数组元素进行分类
// 分类规则就是 behavior 函数
var group = function(behavior) {
return function(obj, iteratee, context) {
// 返回结果是一个对象
var result = {};
iteratee = cb(iteratee, context);
// 遍历元素
_.each(obj, function(value, index) {
// 经过迭代,获取结果值,存为 key
var key = iteratee(value, index, obj);
// 按照不同的规则进行分组操作
// 将变量 result 当做参数传入,能在 behavior 中改变该值
behavior(result, value, key);
});
// 返回结果对象
return result;
};
};

// Groups the object's values by a criterion. Pass either a string attribute
// to group by, or a function that returns the criterion.
// groupBy_ _.groupBy(list, iteratee, [context])
// 根据特定规则对数组或者对象中的元素进行分组
// result 是返回对象
// value 是数组元素
// key 是迭代后的值
_.groupBy = group(function(result, value, key) {
// 根据 key 值分组
// key 是元素经过迭代函数后的值
// 或者元素自身的属性值

// result 对象已经有该 key 值了
if (_.has(result, key))
result[key].push(value);
else result[key] = [value];
});

// Indexes the object's values by a criterion, similar to `groupBy`, but for
// when you know that your index values will be unique.
_.indexBy = group(function(result, value, key) {
// key 值必须是独一无二的
// 不然后面的会覆盖前面的
// 其他和 _.groupBy 类似
result[key] = value;
});

// Counts instances of an object that group by a certain criterion. Pass
// either a string attribute to count by, or a function that returns the
// criterion.
_.countBy = group(function(result, value, key) {
// 不同 key 值元素数量
if (_.has(result, key))
result[key]++;
else result[key] = 1;
});

// Safely create a real, live array from anything iterable.
// 伪数组 -> 数组
// 对象 -> 提取 value 值组成数组
// 返回数组
_.toArray = function(obj) {
if (!obj) return [];

// 如果是数组,则返回副本数组
// 是否用 obj.concat() 更方便?
if (_.isArray(obj)) return slice.call(obj);

// 如果是类数组,则重新构造新的数组
// 是否也可以直接用 slice 方法?
if (isArrayLike(obj)) return _.map(obj, _.identity);

// 如果是对象,则返回 values 集合
return _.values(obj);
};

// Return the number of elements in an object.
// 如果是数组(类数组),返回长度(length 属性)
// 如果是对象,返回键值对数量
_.size = function(obj) {
if (obj == null) return 0;
return isArrayLike(obj) ? obj.length : _.keys(obj).length;
};

// Split a collection into two arrays: one whose elements all satisfy the given
// predicate, and one whose elements all do not satisfy the predicate.
// 将数组或者对象中符合条件(predicate)的元素
// 和不符合条件的元素(数组为元素,对象为 value 值)
// 分别放入两个数组中
// 返回一个数组,数组元素为以上两个数组([[pass array], [fail array]])
_.partition = function(obj, predicate, context) {
predicate = cb(predicate, context);
var pass = [], fail = [];
_.each(obj, function(value, key, obj) {
(predicate(value, key, obj) ? pass : fail).push(value);
});
return [pass, fail];
};


// Array Functions
// 数组的扩展方法
// 共 20 个扩展方法
// Note: All array functions will also work on the arguments object.
// However, Underscore functions are not designed to work on "sparse" arrays.
// ---------------

// Get the first element of an array. Passing **n** will return the first N
// values in the array. Aliased as `head` and `take`. The **guard** check
// allows it to work with `_.map`.
// 返回数组第一个元素
// 如果有参数 n,则返回数组前 n 个元素(组成的数组)
_.first = _.head = _.take = function(array, n, guard) {
// 容错,数组为空则返回 undefined
if (array == null) return void 0;

// 没指定参数 n,则默认返回第一个元素
if (n == null || guard) return array[0];

// 如果传入参数 n,则返回前 n 个元素组成的数组
// 返回前 n 个元素,即剔除后 array.length - n 个元素
return _.initial(array, array.length - n);
};

// Returns everything but the last entry of the array. Especially useful on
// the arguments object. Passing **n** will return all the values in
// the array, excluding the last N.
// 传入一个数组
// 返回剔除最后一个元素之后的数组副本
// 如果传入参数 n,则剔除最后 n 个元素
_.initial = function(array, n, guard) {
return slice.call(array, 0, Math.max(0, array.length - (n == null || guard ? 1 : n)));
};

// Get the last element of an array. Passing **n** will return the last N
// values in the array.
// 返回数组最后一个元素
// 如果传入参数 n
// 则返回该数组后 n 个元素组成的数组
// 即剔除前 array.length - n 个元素
_.last = function(array, n, guard) {
// 容错
if (array == null) return void 0;

// 如果没有指定参数 n,则返回最后一个元素
if (n == null || guard) return array[array.length - 1];

// 如果传入参数 n,则返回后 n 个元素组成的数组
// 即剔除前 array.length - n 个元素
return _.rest(array, Math.max(0, array.length - n));
};

// Returns everything but the first entry of the array. Aliased as `tail` and `drop`.
// Especially useful on the arguments object. Passing an **n** will return
// the rest N values in the array.
// 传入一个数组
// 返回剔除第一个元素后的数组副本
// 如果传入参数 n,则剔除前 n 个元素
_.rest = _.tail = _.drop = function(array, n, guard) {
return slice.call(array, n == null || guard ? 1 : n);
};

// Trim out all falsy values from an array.
// 去掉数组中所有的假值
// 返回数组副本
// JavaScript 中的假值包括 false、null、undefined、''、NaN、0
// 联想 PHP 中的 array_filter() 函数
// _.identity = function(value) {
// return value;
// };
_.compact = function(array) {
return _.filter(array, _.identity);
};

// Internal implementation of a recursive `flatten` function.
// 递归调用数组,将数组展开
// 即 [1, 2, [3, 4]] => [1, 2, 3, 4]
// flatten(array, shallow, false)
// flatten(arguments, true, true, 1)
// flatten(arguments, true, true)
// flatten(arguments, false, false, 1)
// ===== //
// input => Array 或者 arguments
// shallow => 是否只展开一层
// strict === true,通常和 shallow === true 配合使用
// 表示只展开一层,但是不保存非数组元素(即无法展开的基础类型)
// flatten([[1, 2], 3, 4], true, true) => [1, 2]
// flatten([[1, 2], 3, 4], false, true) = > []
// startIndex => 从 input 的第几项开始展开
// ===== //
// 可以看到,如果 strict 参数为 true,那么 shallow 也为 true
// 也就是展开一层,同时把非数组过滤
// [[1, 2], [3, 4], 5, 6] => [1, 2, 3, 4]
var flatten = function(input, shallow, strict, startIndex) {
// output 数组保存结果
// 即 flatten 方法返回数据
// idx 为 output 的累计数组下标
var output = [], idx = 0;

// 根据 startIndex 变量确定需要展开的起始位置
for (var i = startIndex || 0, length = getLength(input); i < length; i++) {
var value = input[i];
// 数组 或者 arguments
// 注意 isArrayLike 还包括 {length: 10} 这样的,过滤掉
if (isArrayLike(value) && (_.isArray(value) || _.isArguments(value))) {
// flatten current level of array or arguments object
// (!shallow === true) => (shallow === false)
// 则表示需深度展开
// 继续递归展开
if (!shallow)
// flatten 方法返回数组
// 将上面定义的 value 重新赋值
value = flatten(value, shallow, strict);

// 递归展开到最后一层(没有嵌套的数组了)
// 或者 (shallow === true) => 只展开一层
// value 值肯定是一个数组
var j = 0, len = value.length;

// 这一步貌似没有必要
// 毕竟 JavaScript 的数组会自动扩充
// 但是这样写,感觉比较好,对于元素的 push 过程有个比较清晰的认识
output.length += len;

// 将 value 数组的元素添加到 output 数组中
while (j < len) {
output[idx++] = value[j++];
}
} else if (!strict) {
// (!strict === true) => (strict === false)
// 如果是深度展开,即 shallow 参数为 false
// 那么当最后 value 不是数组,是基本类型时
// 肯定会走到这个 else-if 判断中
// 而如果此时 strict 为 true,则不能跳到这个分支内部
// 所以 shallow === false 如果和 strict === true 搭配
// 调用 flatten 方法得到的结果永远是空数组 []
output[idx++] = value;
}
}

return output;
};

// Flatten out an array, either recursively (by default), or just one level.
// 将嵌套的数组展开
// 如果参数 (shallow === true),则仅展开一层
// _.flatten([1, [2], [3, [[4]]]]);
// => [1, 2, 3, 4];
// ====== //
// _.flatten([1, [2], [3, [[4]]]], true);
// => [1, 2, 3, [[4]]];
_.flatten = function(array, shallow) {
// array => 需要展开的数组
// shallow => 是否只展开一层
// false 为 flatten 方法 strict 变量
return flatten(array, shallow, false);
};

// Return a version of the array that does not contain the specified value(s).
// without_.without(array, *values)
// Returns a copy of the array with all instances of the values removed.
// ====== //
// _.without([1, 2, 1, 0, 3, 1, 4], 0, 1);
// => [2, 3, 4]
// ===== //
// 从数组中移除指定的元素
// 返回移除后的数组副本
_.without = function(array) {
// slice.call(arguments, 1)
// 将 arguments 转为数组(同时去掉第一个元素)
// 之后便可以调用 _.difference 方法
return _.difference(array, slice.call(arguments, 1));
};

// Produce a duplicate-free version of the array. If the array has already
// been sorted, you have the option of using a faster algorithm.
// Aliased as `unique`.
// 数组去重
// 如果第二个参数 `isSorted` 为 true
// 则说明事先已经知道数组有序
// 程序会跑一个更快的算法(一次线性比较,元素和数组前一个元素比较即可)
// 如果有第三个参数 iteratee,则对数组每个元素迭代
// 对迭代之后的结果进行去重
// 返回去重后的数组(array 的子数组)
// PS: 暴露的 API 中没 context 参数
// _.uniq(array, [isSorted], [iteratee])
_.uniq = _.unique = function(array, isSorted, iteratee, context) {
// 没有传入 isSorted 参数
// 转为 _.unique(array, false, undefined, iteratee)
if (!_.isBoolean(isSorted)) {
context = iteratee;
iteratee = isSorted;
isSorted = false;
}

// 如果有迭代函数
// 则根据 this 指向二次返回新的迭代函数
if (iteratee != null)
iteratee = cb(iteratee, context);

// 结果数组,是 array 的子集
var result = [];

// 已经出现过的元素(或者经过迭代过的值)
// 用来过滤重复值
var seen = [];

for (var i = 0, length = getLength(array); i < length; i++) {
var value = array[i],
// 如果指定了迭代函数
// 则对数组每一个元素进行迭代
// 迭代函数传入的三个参数通常是 value, index, array 形式
computed = iteratee ? iteratee(value, i, array) : value;

// 如果是有序数组,则当前元素只需跟上一个元素对比即可
// 用 seen 变量保存上一个元素
if (isSorted) {
// 如果 i === 0,是第一个元素,则直接 push
// 否则比较当前元素是否和前一个元素相等
if (!i || seen !== computed) result.push(value);
// seen 保存当前元素,供下一次对比
seen = computed;
} else if (iteratee) {
// 如果 seen[] 中没有 computed 这个元素值
if (!_.contains(seen, computed)) {
seen.push(computed);
result.push(value);
}
} else if (!_.contains(result, value)) {
// 如果不用经过迭代函数计算,也就不用 seen[] 变量了
result.push(value);
}
}

return result;
};

// Produce an array that contains the union: each distinct element from all of
// the passed-in arrays.
// union_.union(*arrays)
// Computes the union of the passed-in arrays:
// the list of unique items, in order, that are present in one or more of the arrays.
// ========== //
// _.union([1, 2, 3], [101, 2, 1, 10], [2, 1]);
// => [1, 2, 3, 101, 10]
// ========== //
// 将多个数组的元素集中到一个数组中
// 并且去重,返回数组副本
_.union = function() {
// 首先用 flatten 方法将传入的数组展开成一个数组
// 然后就可以愉快地调用 _.uniq 方法了
// 假设 _.union([1, 2, 3], [101, 2, 1, 10], [2, 1]);
// arguments 为 [[1, 2, 3], [101, 2, 1, 10], [2, 1]]
// shallow 参数为 true,展开一层
// 结果为 [1, 2, 3, 101, 2, 1, 10, 2, 1]
// 然后对其去重
return _.uniq(flatten(arguments, true, true));
};

// Produce an array that contains every item shared between all the
// passed-in arrays.
// 寻找几个数组中共有的元素
// 将这些每个数组中都有的元素存入另一个数组中返回
// _.intersection(*arrays)
// _.intersection([1, 2, 3, 1], [101, 2, 1, 10, 1], [2, 1, 1])
// => [1, 2]
// 注意:返回的结果数组是去重的
_.intersection = function(array) {
// 结果数组
var result = [];

// 传入的参数(数组)个数
var argsLength = arguments.length;

// 遍历第一个数组的元素
for (var i = 0, length = getLength(array); i < length; i++) {
var item = array[i];

// 如果 result[] 中已经有 item 元素了,continue
// 即 array 中出现了相同的元素
// 返回的 result[] 其实是个 "集合"(是去重的)
if (_.contains(result, item)) continue;

// 判断其他参数数组中是否都有 item 这个元素
for (var j = 1; j < argsLength; j++) {
if (!_.contains(arguments[j], item))
break;
}

// 遍历其他参数数组完毕
// j === argsLength 说明其他参数数组中都有 item 元素
// 则将其放入 result[] 中
if (j === argsLength)
result.push(item);
}

return result;
};

// Take the difference between one array and a number of other arrays.
// Only the elements present in just the first array will remain.
// _.difference(array, *others)
// Similar to without, but returns the values from array that are not present in the other arrays.
// ===== //
// _.difference([1, 2, 3, 4, 5], [5, 2, 10]);
// => [1, 3, 4]
// ===== //
// 剔除 array 数组中在 others 数组中出现的元素
_.difference = function(array) {
// 将 others 数组展开一层
// rest[] 保存展开后的元素组成的数组
// strict 参数为 true
// 不可以这样用 _.difference([1, 2, 3, 4, 5], [5, 2], 10);
// 10 就会取不到
var rest = flatten(arguments, true, true, 1);

// 遍历 array,过滤
return _.filter(array, function(value){
// 如果 value 存在在 rest 中,则过滤掉
return !_.contains(rest, value);
});
};

// Zip together multiple lists into a single array -- elements that share
// an index go together.
// ===== //
// _.zip(['moe', 'larry', 'curly'], [30, 40, 50], [true, false, false]);
// => [["moe", 30, true], ["larry", 40, false], ["curly", 50, false]]
// ===== //
// 将多个数组中相同位置的元素归类
// 返回一个数组
_.zip = function() {
return _.unzip(arguments);
};

// Complement of _.zip. Unzip accepts an array of arrays and groups
// each array's elements on shared indices
// The opposite of zip. Given an array of arrays,
// returns a series of new arrays,
// the first of which contains all of the first elements in the input arrays,
// the second of which contains all of the second elements, and so on.
// ===== //
// _.unzip([["moe", 30, true], ["larry", 40, false], ["curly", 50, false]]);
// => [['moe', 'larry', 'curly'], [30, 40, 50], [true, false, false]]
// ===== //
_.unzip = function(array) {
var length = array && _.max(array, getLength).length || 0;
var result = Array(length);

for (var index = 0; index < length; index++) {
result[index] = _.pluck(array, index);
}
return result;
};

// Converts lists into objects. Pass either a single array of `[key, value]`
// pairs, or two parallel arrays of the same length -- one of keys, and one of
// the corresponding values.
// 将数组转化为对象
_.object = function(list, values) {
var result = {};
for (var i = 0, length = getLength(list); i < length; i++) {
if (values) {
result[list[i]] = values[i];
} else {
result[list[i][0]] = list[i][1];
}
}
return result;
};

// Generator function to create the findIndex and findLastIndex functions
// (dir === 1) => 从前往后找
// (dir === -1) => 从后往前找
function createPredicateIndexFinder(dir) {
// 经典闭包
return function(array, predicate, context) {
predicate = cb(predicate, context);

var length = getLength(array);

// 根据 dir 变量来确定数组遍历的起始位置
var index = dir > 0 ? 0 : length - 1;

for (; index >= 0 && index < length; index += dir) {
// 找到第一个符合条件的元素
// 并返回下标值
if (predicate(array[index], index, array))
return index;
}

return -1;
};
}

// Returns the first index on an array-like that passes a predicate test
// 从前往后找到数组中 `第一个满足条件` 的元素,并返回下标值
// 没找到返回 -1
// _.findIndex(array, predicate, [context])
_.findIndex = createPredicateIndexFinder(1);

// 从后往前找到数组中 `第一个满足条件` 的元素,并返回下标值
// 没找到返回 -1
// _.findLastIndex(array, predicate, [context])
_.findLastIndex = createPredicateIndexFinder(-1);

// Use a comparator function to figure out the smallest index at which
// an object should be inserted so as to maintain order. Uses binary search.
// The iteratee may also be the string name of the property to sort by (eg. length).
// ===== //
// _.sortedIndex([10, 20, 30, 40, 50], 35);
// => 3
// ===== //
// var stooges = [{name: 'moe', age: 40}, {name: 'curly', age: 60}];
// _.sortedIndex(stooges, {name: 'larry', age: 50}, 'age');
// => 1
// ===== //
// 二分查找
// 将一个元素插入已排序的数组
// 返回该插入的位置下标
// _.sortedIndex(list, value, [iteratee], [context])
_.sortedIndex = function(array, obj, iteratee, context) {
// 注意 cb 方法
// iteratee 为空 || 为 String 类型(key 值)时会返回不同方法
iteratee = cb(iteratee, context, 1);

// 经过迭代函数计算的值
// 可打印 iteratee 出来看看
var value = iteratee(obj);

var low = 0, high = getLength(array);

// 二分查找
while (low < high) {
var mid = Math.floor((low + high) / 2);
if (iteratee(array[mid]) < value)
low = mid + 1;
else
high = mid;
}

return low;
};

// Generator function to create the indexOf and lastIndexOf functions
// _.indexOf = createIndexFinder(1, _.findIndex, _.sortedIndex);
// _.lastIndexOf = createIndexFinder(-1, _.findLastIndex);
function createIndexFinder(dir, predicateFind, sortedIndex) {
// API 调用形式
// _.indexOf(array, value, [isSorted])
// _.indexOf(array, value, [fromIndex])
// _.lastIndexOf(array, value, [fromIndex])
return function(array, item, idx) {
var i = 0, length = getLength(array);

// 如果 idx 为 Number 类型
// 则规定查找位置的起始点
// 那么第三个参数不是 [isSorted]
// 所以不能用二分查找优化了
// 只能遍历查找
if (typeof idx == 'number') {
if (dir > 0) { // 正向查找
// 重置查找的起始位置
i = idx >= 0 ? idx : Math.max(idx + length, i);
} else { // 反向查找
// 如果是反向查找,重置 length 属性值
length = idx >= 0 ? Math.min(idx + 1, length) : idx + length + 1;
}
} else if (sortedIndex && idx && length) {
// 能用二分查找加速的条件
// 有序 & idx !== 0 && length !== 0

// 用 _.sortIndex 找到有序数组中 item 正好插入的位置
idx = sortedIndex(array, item);

// 如果正好插入的位置的值和 item 刚好相等
// 说明该位置就是 item 第一次出现的位置
// 返回下标
// 否则即是没找到,返回 -1
return array[idx] === item ? idx : -1;
}

// 特判,如果要查找的元素是 NaN 类型
// 如果 item !== item
// 那么 item => NaN
if (item !== item) {
idx = predicateFind(slice.call(array, i, length), _.isNaN);
return idx >= 0 ? idx + i : -1;
}

// O(n) 遍历数组
// 寻找和 item 相同的元素
// 特判排除了 item 为 NaN 的情况
// 可以放心地用 `===` 来判断是否相等了
for (idx = dir > 0 ? i : length - 1; idx >= 0 && idx < length; idx += dir) {
if (array[idx] === item) return idx;
}

return -1;
};
}

// Return the position of the first occurrence of an item in an array,
// or -1 if the item is not included in the array.
// If the array is large and already in sort order, pass `true`
// for **isSorted** to use binary search.
// _.indexOf(array, value, [isSorted])
// 找到数组 array 中 value 第一次出现的位置
// 并返回其下标值
// 如果数组有序,则第三个参数可以传入 true
// 这样算法效率会更高(二分查找)
// [isSorted] 参数表示数组是否有序
// 同时第三个参数也可以表示 [fromIndex] (见下面的 _.lastIndexOf)
_.indexOf = createIndexFinder(1, _.findIndex, _.sortedIndex);

// 和 _indexOf 相似
// 反序查找
// _.lastIndexOf(array, value, [fromIndex])
// [fromIndex] 参数表示从倒数第几个开始往前找
_.lastIndexOf = createIndexFinder(-1, _.findLastIndex);

// Generate an integer Array containing an arithmetic progression. A port of
// the native Python `range()` function. See
// [the Python documentation](http://docs.python.org/library/functions.html#range).
// 返回某一个范围内的数组成的数组
_.range = function(start, stop, step) {
if (stop == null) {
stop = start || 0;
start = 0;
}

step = step || 1;

// 返回数组的长度
var length = Math.max(Math.ceil((stop - start) / step), 0);

// 返回的数组
var range = Array(length);

for (var idx = 0; idx < length; idx++, start += step) {
range[idx] = start;
}

return range;
};


// Function (ahem) Functions
// 函数的扩展方法
// 共 14 个扩展方法
// ------------------

// Determines whether to execute a function as a constructor
// or a normal function with the provided arguments
var executeBound = function(sourceFunc, boundFunc, context, callingContext, args) {
// 非 new 调用 _.bind 返回的方法(即 bound)
// callingContext 不是 boundFunc 的一个实例
if (!(callingContext instanceof boundFunc))
return sourceFunc.apply(context, args);

// 如果是用 new 调用 _.bind 返回的方法

// self 为 sourceFunc 的实例,继承了它的原型链
// self 理论上是一个空对象(还没赋值),但是有原型链
var self = baseCreate(sourceFunc.prototype);

// 用 new 生成一个构造函数的实例
// 正常情况下是没有返回值的,即 result 值为 undefined
// 如果构造函数有返回值
// 如果返回值是对象(非 null),则 new 的结果返回这个对象
// 否则返回实例
// @see http://www.cnblogs.com/zichi/p/4392944.html
var result = sourceFunc.apply(self, args);

// 如果构造函数返回了对象
// 则 new 的结果是这个对象
// 返回这个对象
if (_.isObject(result)) return result;

// 否则返回 self
// var result = sourceFunc.apply(self, args);
// self 对象当做参数传入
// 会直接改变值
return self;
};

// Create a function bound to a given object (assigning `this`, and arguments,
// optionally). Delegates to **ECMAScript 5**'s native `Function.bind` if
// available.
// ES5 bind 方法的扩展(polyfill)
// 将 func 中的 this 指向 context(对象)
// _.bind(function, object, *arguments)
// 可选的 arguments 参数会被当作 func 的参数传入
// func 在调用时,会优先用 arguments 参数,然后使用 _.bind 返回方法所传入的参数
_.bind = function(func, context) {
// 如果浏览器支持 ES5 bind 方法,并且 func 上的 bind 方法没有被重写
// 则优先使用原生的 bind 方法
if (nativeBind && func.bind === nativeBind)
return nativeBind.apply(func, slice.call(arguments, 1));

// 如果传入的参数 func 不是方法,则抛出错误
if (!_.isFunction(func))
throw new TypeError('Bind must be called on a function');

// polyfill
// 经典闭包,函数返回函数
// args 获取优先使用的参数
var args = slice.call(arguments, 2);
var bound = function() {
// args.concat(slice.call(arguments))
// 最终函数的实际调用参数由两部分组成
// 一部分是传入 _.bind 的参数(会被优先调用)
// 另一部分是传入 bound(_.bind 所返回方法)的参数
return executeBound(func, bound, context, this, args.concat(slice.call(arguments)));
};

return bound;
};

// Partially apply a function by creating a version that has had some of its
// arguments pre-filled, without changing its dynamic `this` context. _ acts
// as a placeholder, allowing any combination of arguments to be pre-filled.
// _.partial(function, *arguments)
// _.partial 能返回一个方法
// pre-fill 该方法的一些参数
_.partial = function(func) {
// 提取希望 pre-fill 的参数
// 如果传入的是 _,则这个位置的参数暂时空着,等待手动填入
var boundArgs = slice.call(arguments, 1);

var bound = function() {
var position = 0, length = boundArgs.length;
var args = Array(length);
for (var i = 0; i < length; i++) {
// 如果该位置的参数为 _,则用 bound 方法的参数填充这个位置
// args 为调用 _.partial 方法的 pre-fill 的参数 & bound 方法的 arguments
args[i] = boundArgs[i] === _ ? arguments[position++] : boundArgs[i];
}

// bound 方法还有剩余的 arguments,添上去
while (position < arguments.length)
args.push(arguments[position++]);

return executeBound(func, bound, this, this, args);
};

return bound;
};

// Bind a number of an object's methods to that object. Remaining arguments
// are the method names to be bound. Useful for ensuring that all callbacks
// defined on an object belong to it.
// 指定一系列方法(methodNames)中的 this 指向(object)
// _.bindAll(object, *methodNames)
_.bindAll = function(obj) {
var i, length = arguments.length, key;

// 如果只传入了一个参数(obj),没有传入 methodNames,则报错
if (length <= 1)
throw new Error('bindAll must be passed function names');

// 遍历 methodNames
for (i = 1; i < length; i++) {
key = arguments[i];
// 逐个绑定
obj[key] = _.bind(obj[key], obj);
}
return obj;
};

// Memoize an expensive function by storing its results.
//「记忆化」,存储中间运算结果,提高效率
// 参数 hasher 是个 function,用来计算 key
// 如果传入了 hasher,则用 hasher 来计算 key
// 否则用 key 参数直接当 key(即 memoize 方法传入的第一个参数)
// _.memoize(function, [hashFunction])
// 适用于需要大量重复求值的场景
// 比如递归求解菲波那切数
// @http://www.jameskrob.com/memoize.html
// create hash for storing "expensive" function outputs
// run expensive function
// check whether function has already been run with given arguments via hash lookup
// if false - run function, and store output in hash
// if true, return output stored in hash
_.memoize = function(func, hasher) {
var memoize = function(key) {
// 储存变量,方便使用
var cache = memoize.cache;

// 求 key
// 如果传入了 hasher,则用 hasher 函数来计算 key
// 否则用 参数 key(即 memoize 方法传入的第一个参数)当 key
var address = '' + (hasher ? hasher.apply(this, arguments) : key);

// 如果这个 key 还没被 hash 过(还没求过值)
if (!_.has(cache, address))
cache[address] = func.apply(this, arguments);

// 返回
return cache[address];
};

// cache 对象被当做 key-value 键值对缓存中间运算结果
memoize.cache = {};

// 返回一个函数(经典闭包)
return memoize;
};

// Delays a function for the given number of milliseconds, and then calls
// it with the arguments supplied.
// 延迟触发某方法
// _.delay(function, wait, *arguments)
// 如果传入了 arguments 参数,则会被当作 func 的参数在触发时调用
// 其实是封装了「延迟触发某方法」,使其复用
_.delay = function(func, wait) {
// 获取 *arguments
// 是 func 函数所需要的参数
var args = slice.call(arguments, 2);
return setTimeout(function(){
// 将参数赋予 func 函数
return func.apply(null, args);
}, wait);
};

// Defers a function, scheduling it to run after the current call stack has
// cleared.
// 和 setTimeout(func, 0) 相似(源码看来似乎应该是 setTimeout(func, 1))
// _.defer(function, *arguments)
// 如果传入 *arguments,会被当做参数,和 _.delay 调用方式类似(少了第二个参数)
// 其实核心还是调用了 _.delay 方法,但第二个参数(wait 参数)设置了默认值为 1
// 如何使得方法能设置默认值?用 _.partial 方法
_.defer = _.partial(_.delay, _, 1);

// Returns a function, that, when invoked, will only be triggered at most once
// during a given window of time. Normally, the throttled function will run
// as much as it can, without ever going more than once per `wait` duration;
// but if you'd like to disable the execution on the leading edge, pass
// `{leading: false}`. To disable execution on the trailing edge, ditto.
// 函数节流(如果有连续事件响应,则每间隔一定时间段触发)
// 每间隔 wait(Number) milliseconds 触发一次 func 方法
// 如果 options 参数传入 {leading: false}
// 那么不会马上触发(等待 wait milliseconds 后第一次触发 func)
// 如果 options 参数传入 {trailing: false}
// 那么最后一次回调不会被触发
// **Notice: options 不能同时设置 leading 和 trailing 为 false**
// 示例:
// var throttled = _.throttle(updatePosition, 100);
// $(window).scroll(throttled);
// 调用方式(注意看 A 和 B console.log 打印的位置):
// _.throttle(function, wait, [options])
// sample 1: _.throttle(function(){}, 1000)
// print: A, B, B, B ...
// sample 2: _.throttle(function(){}, 1000, {leading: false})
// print: B, B, B, B ...
// sample 3: _.throttle(function(){}, 1000, {trailing: false})
// print: A, A, A, A ...
// ----------------------------------------- //
_.throttle = function(func, wait, options) {
var context, args, result;

// setTimeout 的 handler
var timeout = null;

// 标记时间戳
// 上一次执行回调的时间戳
var previous = 0;

// 如果没有传入 options 参数
// 则将 options 参数置为空对象
if (!options)
options = {};

var later = function() {
// 如果 options.leading === false
// 则每次触发回调后将 previous 置为 0
// 否则置为当前时间戳
previous = options.leading === false ? 0 : _.now();
timeout = null;
// console.log('B')
result = func.apply(context, args);

// 这里的 timeout 变量一定是 null 了吧
// 是否没有必要进行判断?
if (!timeout)
context = args = null;
};

// 以滚轮事件为例(scroll)
// 每次触发滚轮事件即执行这个返回的方法
// _.throttle 方法返回的函数
return function() {
// 记录当前时间戳
var now = _.now();

// 第一次执行回调(此时 previous 为 0,之后 previous 值为上一次时间戳)
// 并且如果程序设定第一个回调不是立即执行的(options.leading === false)
// 则将 previous 值(表示上次执行的时间戳)设为 now 的时间戳(第一次触发时)
// 表示刚执行过,这次就不用执行了
if (!previous && options.leading === false)
previous = now;

// 距离下次触发 func 还需要等待的时间
var remaining = wait - (now - previous);
context = this;
args = arguments;

// 要么是到了间隔时间了,随即触发方法(remaining <= 0)
// 要么是没有传入 {leading: false},且第一次触发回调,即立即触发
// 此时 previous 为 0,wait - (now - previous) 也满足 <= 0
// 之后便会把 previous 值迅速置为 now
// ========= //
// remaining > wait,表示客户端系统时间被调整过
// 则马上执行 func 函数
// @see https://blog.coding.net/blog/the-difference-between-throttle-and-debounce-in-underscorejs
// ========= //

// console.log(remaining) 可以打印出来看看
if (remaining <= 0 || remaining > wait) {
if (timeout) {
clearTimeout(timeout);
// 解除引用,防止内存泄露
timeout = null;
}

// 重置前一次触发的时间戳
previous = now;

// 触发方法
// result 为该方法返回值
// console.log('A')
result = func.apply(context, args);

// 引用置为空,防止内存泄露
// 感觉这里的 timeout 肯定是 null 啊?这个 if 判断没必要吧?
if (!timeout)
context = args = null;
} else if (!timeout && options.trailing !== false) { // 最后一次需要触发的情况
// 如果已经存在一个定时器,则不会进入该 if 分支
// 如果 {trailing: false},即最后一次不需要触发了,也不会进入这个分支
// 间隔 remaining milliseconds 后触发 later 方法
timeout = setTimeout(later, remaining);
}

// 回调返回值
return result;
};
};

// Returns a function, that, as long as it continues to be invoked, will not
// be triggered. The function will be called after it stops being called for
// N milliseconds. If `immediate` is passed, trigger the function on the
// leading edge, instead of the trailing.
// 函数去抖(连续事件触发结束后只触发一次)
// sample 1: _.debounce(function(){}, 1000)
// 连续事件结束后的 1000ms 后触发
// sample 1: _.debounce(function(){}, 1000, true)
// 连续事件触发后立即触发(此时会忽略第二个参数)
_.debounce = function(func, wait, immediate) {
var timeout, args, context, timestamp, result;

var later = function() {
// 定时器设置的回调 later 方法的触发时间,和连续事件触发的最后一次时间戳的间隔
// 如果间隔为 wait(或者刚好大于 wait),则触发事件
var last = _.now() - timestamp;

// 时间间隔 last 在 [0, wait) 中
// 还没到触发的点,则继续设置定时器
// last 值应该不会小于 0 吧?
if (last < wait && last >= 0) {
timeout = setTimeout(later, wait - last);
} else {
// 到了可以触发的时间点
timeout = null;
// 可以触发了
// 并且不是设置为立即触发的
// 因为如果是立即触发(callNow),也会进入这个回调中
// 主要是为了将 timeout 值置为空,使之不影响下次连续事件的触发
// 如果不是立即执行,随即执行 func 方法
if (!immediate) {
// 执行 func 函数
result = func.apply(context, args);
// 这里的 timeout 一定是 null 了吧
// 感觉这个判断多余了
if (!timeout)
context = args = null;
}
}
};

// 嗯,闭包返回的函数,是可以传入参数的
// 也是 DOM 事件所触发的回调函数
return function() {
// 可以指定 this 指向
context = this;
args = arguments;

// 每次触发函数,更新时间戳
// later 方法中取 last 值时用到该变量
// 判断距离上次触发事件是否已经过了 wait seconds 了
// 即我们需要距离最后一次事件触发 wait seconds 后触发这个回调方法
timestamp = _.now();

// 立即触发需要满足两个条件
// immediate 参数为 true,并且 timeout 还没设置
// immediate 参数为 true 是显而易见的
// 如果去掉 !timeout 的条件,就会一直触发,而不是触发一次
// 因为第一次触发后已经设置了 timeout,所以根据 timeout 是否为空可以判断是否是首次触发
var callNow = immediate && !timeout;

// 设置 wait seconds 后触发 later 方法
// 无论是否 callNow(如果是 callNow,也进入 later 方法,去 later 方法中判断是否执行相应回调函数)
// 在某一段的连续触发中,只会在第一次触发时进入这个 if 分支中
if (!timeout)
// 设置了 timeout,所以以后不会进入这个 if 分支了
timeout = setTimeout(later, wait);

// 如果是立即触发
if (callNow) {
// func 可能是有返回值的
result = func.apply(context, args);
// 解除引用
context = args = null;
}

return result;
};
};

// Returns the first function passed as an argument to the second,
// allowing you to adjust arguments, run code before and after, and
// conditionally execute the original function.
_.wrap = function(func, wrapper) {
return _.partial(wrapper, func);
};

// Returns a negated version of the passed-in predicate.
// 返回一个 predicate 方法的对立方法
// 即该方法可以对原来的 predicate 迭代结果值取补集
_.negate = function(predicate) {
return function() {
return !predicate.apply(this, arguments);
};
};

// Returns a function that is the composition of a list of functions, each
// consuming the return value of the function that follows.
// _.compose(*functions)
// var tmp = _.compose(f, g, h)
// tmp(args) => f(g(h(args)))
_.compose = function() {
var args = arguments; // funcs
var start = args.length - 1; // 倒序调用
return function() {
var i = start;
var result = args[start].apply(this, arguments);
// 一个一个方法地执行
while (i--)
result = args[i].call(this, result);
return result;
};
};

// Returns a function that will only be executed on and after the Nth call.
// 第 times 触发执行 func(事实上之后的每次触发还是会执行 func)
// 有什么用呢?
// 如果有 N 个异步事件,所有异步执行完后执行该回调,即 func 方法(联想 eventproxy)
// _.after 会返回一个函数
// 当这个函数第 times 被执行的时候
// 触发 func 方法
_.after = function(times, func) {
return function() {
// 函数被触发了 times 了,则执行 func 函数
// 事实上 times 次后如果函数继续被执行,也会触发 func
if (--times < 1) {
return func.apply(this, arguments);
}
};
};

// Returns a function that will only be executed up to (but not including) the Nth call.
// 函数至多被调用 times - 1 次((but not including) the Nth call)
// func 函数会触发 time - 1 次(Creates a version of the function that can be called no more than count times)
// func 函数有个返回值,前 time - 1 次触发的返回值都是将参数代入重新计算的
// 第 times 开始的返回值为第 times - 1 次时的返回值(不重新计算)
// The result of the last function call is memoized and returned when count has been reached.
_.before = function(times, func) {
var memo;
return function() {
if (--times > 0) {
// 缓存函数执行结果
memo = func.apply(this, arguments);
}

// func 引用置为空,其实不置为空也用不到 func 了
if (times <= 1)
func = null;

// 前 times - 1 次触发,memo 都是分别计算返回
// 第 times 次开始,memo 值同 times - 1 次时的 memo
return memo;
};
};

// Returns a function that will be executed at most one time, no matter how
// often you call it. Useful for lazy initialization.
// 函数至多只能被调用一次
// 适用于这样的场景,某些函数只能被初始化一次,不得不设置一个变量 flag
// 初始化后设置 flag 为 true,之后不断 check flag
// ====== //
// 其实是调用了 _.before 方法,并且将 times 参数设置为了默认值 2(也就是 func 至多能被调用 2 - 1 = 1 次)
_.once = _.partial(_.before, 2);


// Object Functions
// 对象的扩展方法
// 共 38 个扩展方法
// ----------------

// Keys in IE < 9 that won't be iterated by `for key in ...` and thus missed.
// IE < 9 下 不能用 for key in ... 来枚举对象的某些 key
// 比如重写了对象的 `toString` 方法,这个 key 值就不能在 IE < 9 下用 for in 枚举到
// IE < 9,{toString: null}.propertyIsEnumerable('toString') 返回 false
// IE < 9,重写的 `toString` 属性被认为不可枚举
// 据此可以判断是否在 IE < 9 浏览器环境中
var hasEnumBug = !{toString: null}.propertyIsEnumerable('toString');

// IE < 9 下不能用 for in 来枚举的 key 值集合
// 其实还有个 `constructor` 属性
// 个人觉得可能是 `constructor` 和其他属性不属于一类
// nonEnumerableProps[] 中都是方法
// 而 constructor 表示的是对象的构造函数
// 所以区分开来了
var nonEnumerableProps = ['valueOf', 'isPrototypeOf', 'toString',
'propertyIsEnumerable', 'hasOwnProperty', 'toLocaleString'];

// obj 为需要遍历键值对的对象
// keys 为键数组
// 利用 JavaScript 按值传递的特点
// 传入数组作为参数,能直接改变数组的值
function collectNonEnumProps(obj, keys) {
var nonEnumIdx = nonEnumerableProps.length;
var constructor = obj.constructor;

// 获取对象的原型
// 如果 obj 的 constructor 被重写
// 则 proto 变量为 Object.prototype
// 如果没有被重写
// 则为 obj.constructor.prototype
var proto = (_.isFunction(constructor) && constructor.prototype) || ObjProto;

// Constructor is a special case.
// `constructor` 属性需要特殊处理 (是否有必要?)
// see https://github.com/hanzichi/underscore-analysis/issues/3
// 如果 obj 有 `constructor` 这个 key
// 并且该 key 没有在 keys 数组中
// 存入 keys 数组
var prop = 'constructor';
if (_.has(obj, prop) && !_.contains(keys, prop)) keys.push(prop);

// 遍历 nonEnumerableProps 数组中的 keys
while (nonEnumIdx--) {
prop = nonEnumerableProps[nonEnumIdx];
// prop in obj 应该肯定返回 true 吧?是否有判断必要?
// obj[prop] !== proto[prop] 判断该 key 是否来自于原型链
// 即是否重写了原型链上的属性
if (prop in obj && obj[prop] !== proto[prop] && !_.contains(keys, prop)) {
keys.push(prop);
}
}
}

// Retrieve the names of an object's own properties.
// Delegates to **ECMAScript 5**'s native `Object.keys`
// ===== //
// _.keys({one: 1, two: 2, three: 3});
// => ["one", "two", "three"]
// ===== //
// 返回一个对象的 keys 组成的数组
// 仅返回 own enumerable properties 组成的数组
_.keys = function(obj) {
// 容错
// 如果传入的参数不是对象,则返回空数组
if (!_.isObject(obj)) return [];

// 如果浏览器支持 ES5 Object.key() 方法
// 则优先使用该方法
if (nativeKeys) return nativeKeys(obj);

var keys = [];

// own enumerable properties
for (var key in obj)
// hasOwnProperty
if (_.has(obj, key)) keys.push(key);

// Ahem, IE < 9.
// IE < 9 下不能用 for in 来枚举某些 key 值
// 传入 keys 数组为参数
// 因为 JavaScript 下函数参数按值传递
// 所以 keys 当做参数传入后会在 `collectNonEnumProps` 方法中改变值
if (hasEnumBug) collectNonEnumProps(obj, keys);

return keys;
};

// Retrieve all the property names of an object.
// 返回一个对象的 keys 数组
// 不仅仅是 own enumerable properties
// 还包括原型链上继承的属性
_.allKeys = function(obj) {
// 容错
// 不是对象,则返回空数组
if (!_.isObject(obj)) return [];

var keys = [];
for (var key in obj) keys.push(key);

// Ahem, IE < 9.
// IE < 9 下的 bug,同 _.keys 方法
if (hasEnumBug) collectNonEnumProps(obj, keys);

return keys;
};

// Retrieve the values of an object's properties.
// ===== //
// _.values({one: 1, two: 2, three: 3});
// => [1, 2, 3]
// ===== //
// 将一个对象的所有 values 值放入数组中
// 仅限 own properties 上的 values
// 不包括原型链上的
// 并返回该数组
_.values = function(obj) {
// 仅包括 own properties
var keys = _.keys(obj);
var length = keys.length;
var values = Array(length);
for (var i = 0; i < length; i++) {
values[i] = obj[keys[i]];
}
return values;
};

// Returns the results of applying the iteratee to each element of the object
// In contrast to _.map it returns an object
// 跟 _.map 方法很像
// 但是是专门为对象服务的 map 方法
// 迭代函数改变对象的 values 值
// 返回对象副本
_.mapObject = function(obj, iteratee, context) {
// 迭代函数
// 对每个键值对进行迭代
iteratee = cb(iteratee, context);

var keys = _.keys(obj),
length = keys.length,
results = {}, // 对象副本,该方法返回的对象
currentKey;

for (var index = 0; index < length; index++) {
currentKey = keys[index];
// key 值不变
// 对每个 value 值用迭代函数迭代
// 返回经过函数运算后的值
results[currentKey] = iteratee(obj[currentKey], currentKey, obj);
}
return results;
};

// Convert an object into a list of `[key, value]` pairs.
// 将一个对象转换为元素为 [key, value] 形式的数组
// _.pairs({one: 1, two: 2, three: 3});
// => [["one", 1], ["two", 2], ["three", 3]]
_.pairs = function(obj) {
var keys = _.keys(obj);
var length = keys.length;
var pairs = Array(length);
for (var i = 0; i < length; i++) {
pairs[i] = [keys[i], obj[keys[i]]];
}
return pairs;
};

// Invert the keys and values of an object. The values must be serializable.
// 将一个对象的 key-value 键值对颠倒
// 即原来的 key 为 value 值,原来的 value 值为 key 值
// 需要注意的是,value 值不能重复(不然后面的会覆盖前面的)
// 且新构造的对象符合对象构造规则
// 并且返回新构造的对象
_.invert = function(obj) {
// 返回的新的对象
var result = {};
var keys = _.keys(obj);
for (var i = 0, length = keys.length; i < length; i++) {
result[obj[keys[i]]] = keys[i];
}
return result;
};

// Return a sorted list of the function names available on the object.
// Aliased as `methods`
// 传入一个对象
// 遍历该对象的键值对(包括 own properties 以及 原型链上的)
// 如果某个 value 的类型是方法(function),则将该 key 存入数组
// 将该数组排序后返回
_.functions = _.methods = function(obj) {
// 返回的数组
var names = [];

// if IE < 9
// 且对象重写了 `nonEnumerableProps` 数组中的某些方法
// 那么这些方法名是不会被返回的
// 可见放弃了 IE < 9 可能对 `toString` 等方法的重写支持
for (var key in obj) {
// 如果某个 key 对应的 value 值类型是函数
// 则将这个 key 值存入数组
if (_.isFunction(obj[key])) names.push(key);
}

// 返回排序后的数组
return names.sort();
};

// Extend a given object with all the properties in passed-in object(s).
// extend_.extend(destination, *sources)
// Copy all of the properties in the source objects over to the destination object
// and return the destination object
// It's in-order, so the last source will override properties of the same name in previous arguments.
// 将几个对象上(第二个参数开始,根据参数而定)的所有键值对添加到 destination 对象(第一个参数)上
// 因为 key 值可能会相同,所以后面的(键值对)可能会覆盖前面的
// 参数个数 >= 1
_.extend = createAssigner(_.allKeys);

// Assigns a given object with all the own properties in the passed-in object(s)
// (https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object/assign)
// 跟 extend 方法类似,但是只把 own properties 拷贝给第一个参数对象
// 只继承 own properties 的键值对
// 参数个数 >= 1
_.extendOwn = _.assign = createAssigner(_.keys);

// Returns the first key on an object that passes a predicate test
// 跟数组方法的 _.findIndex 类似
// 找到对象的键值对中第一个满足条件的键值对
// 并返回该键值对 key 值
_.findKey = function(obj, predicate, context) {
predicate = cb(predicate, context);
var keys = _.keys(obj), key;
// 遍历键值对
for (var i = 0, length = keys.length; i < length; i++) {
key = keys[i];
// 符合条件,直接返回 key 值
if (predicate(obj[key], key, obj)) return key;
}
};

// Return a copy of the object only containing the whitelisted properties.
// 根据一定的需求(key 值,或者通过 predicate 函数返回真假)
// 返回拥有一定键值对的对象副本
// 第二个参数可以是一个 predicate 函数
// 也可以是 >= 0 个 key
// _.pick(object, *keys)
// Return a copy of the object
// filtered to only have values for the whitelisted keys (or array of valid keys)
// Alternatively accepts a predicate indicating which keys to pick.
/*
_.pick({name: 'moe', age: 50, userid: 'moe1'}, 'name', 'age');
=> {name: 'moe', age: 50}
_.pick({name: 'moe', age: 50, userid: 'moe1'}, ['name', 'age']);
=> {name: 'moe', age: 50}
_.pick({name: 'moe', age: 50, userid: 'moe1'}, function(value, key, object) {
return _.isNumber(value);
});
=> {age: 50}
*/
_.pick = function(object, oiteratee, context) {
// result 为返回的对象副本
var result = {}, obj = object, iteratee, keys;

// 容错
if (obj == null) return result;

// 如果第二个参数是函数
if (_.isFunction(oiteratee)) {
keys = _.allKeys(obj);
iteratee = optimizeCb(oiteratee, context);
} else {
// 如果第二个参数不是函数
// 则后面的 keys 可能是数组
// 也可能是连续的几个并列的参数
// 用 flatten 将它们展开
keys = flatten(arguments, false, false, 1);

// 也转为 predicate 函数判断形式
// 将指定 key 转化为 predicate 函数
iteratee = function(value, key, obj) { return key in obj; };
obj = Object(obj);
}

for (var i = 0, length = keys.length; i < length; i++) {
var key = keys[i];
var value = obj[key];
// 满足条件
if (iteratee(value, key, obj)) result[key] = value;
}
return result;
};

// Return a copy of the object without the blacklisted properties.
// 跟 _.pick 方法相对
// 返回 _.pick 的补集
// 即返回没有指定 keys 值的对象副本
// 或者返回不能通过 predicate 函数的对象副本
_.omit = function(obj, iteratee, context) {
if (_.isFunction(iteratee)) {
// _.negate 方法对 iteratee 的结果取反
iteratee = _.negate(iteratee);
} else {
var keys = _.map(flatten(arguments, false, false, 1), String);
iteratee = function(value, key) {
return !_.contains(keys, key);
};
}
return _.pick(obj, iteratee, context);
};

// _.defaults(object, *defaults)
// Fill in a given object with default properties.
// Fill in undefined properties in object
// with the first value present in the following list of defaults objects.
// 和 _.extend 非常类似
// 区别是如果 *defaults 中出现了和 object 中一样的键
// 则不覆盖 object 的键值对
// 如果 *defaults 多个参数对象中有相同 key 的对象
// 则取最早出现的 value 值
// 参数个数 >= 1
_.defaults = createAssigner(_.allKeys, true);

// Creates an object that inherits from the given prototype object.
// If additional properties are provided then they will be added to the
// created object.
// 给定 prototype
// 以及一些 own properties
// 构造一个新的对象并返回
_.create = function(prototype, props) {
var result = baseCreate(prototype);

// 将 props 的键值对覆盖 result 对象
if (props) _.extendOwn(result, props);
return result;
};

// Create a (shallow-cloned) duplicate of an object.
// 对象的 `浅复制` 副本
// 注意点:所有嵌套的对象或者数组都会跟原对象用同一个引用
// 所以是为浅复制,而不是深度克隆
_.clone = function(obj) {
// 容错,如果不是对象或者数组类型,则可以直接返回
// 因为一些基础类型是直接按值传递的
// 思考,arguments 呢? Nodelists 呢? HTML Collections 呢?
if (!_.isObject(obj))
return obj;

// 如果是数组,则用 obj.slice() 返回数组副本
// 如果是对象,则提取所有 obj 的键值对覆盖空对象,返回
return _.isArray(obj) ? obj.slice() : _.extend({}, obj);
};

// Invokes interceptor with the obj, and then returns obj.
// The primary purpose of this method is to "tap into" a method chain, in
// order to perform operations on intermediate results within the chain.
// _.chain([1,2,3,200])
// .filter(function(num) { return num % 2 == 0; })
// .tap(alert)
// .map(function(num) { return num * num })
// .value();
// => // [2, 200] (alerted)
// => [4, 40000]
// 主要是用在链式调用中
// 对中间值立即进行处理
_.tap = function(obj, interceptor) {
interceptor(obj);
return obj;
};

// Returns whether an object has a given set of `key:value` pairs.
// attrs 参数为一个对象
// 判断 object 对象中是否有 attrs 中的所有 key-value 键值对
// 返回布尔值
_.isMatch = function(object, attrs) {
// 提取 attrs 对象的所有 keys
var keys = _.keys(attrs), length = keys.length;

// 如果 object 为空
// 根据 attrs 的键值对数量返回布尔值
if (object == null) return !length;

// 这一步有必要?
var obj = Object(object);

// 遍历 attrs 对象键值对
for (var i = 0; i < length; i++) {
var key = keys[i];

// 如果 obj 对象没有 attrs 对象的某个 key
// 或者对于某个 key,它们的 value 值不同
// 则证明 object 并不拥有 attrs 的所有键值对
// 则返回 false
if (attrs[key] !== obj[key] || !(key in obj)) return false;
}

return true;
};


// Internal recursive comparison function for `isEqual`.
// "内部的"/ "递归地"/ "比较"
// 该内部方法会被递归调用
var eq = function(a, b, aStack, bStack) {
// Identical objects are equal. `0 === -0`, but they aren't identical.
// See the [Harmony `egal` proposal](http://wiki.ecmascript.org/doku.php?id=harmony:egal).
// a === b 时
// 需要注意 `0 === -0` 这个 special case
// 0 和 -0 被认为不相同(unequal)
// 至于原因可以参考上面的链接
if (a === b) return a !== 0 || 1 / a === 1 / b;

// A strict comparison is necessary because `null == undefined`.
// 如果 a 和 b 有一个为 null(或者 undefined)
// 判断 a === b
if (a == null || b == null) return a === b;

// Unwrap any wrapped objects.
// 如果 a 和 b 是 underscore OOP 的对象
// 那么比较 _wrapped 属性值(Unwrap)
if (a instanceof _) a = a._wrapped;
if (b instanceof _) b = b._wrapped;

// Compare `[[Class]]` names.
// 用 Object.prototype.toString.call 方法获取 a 变量类型
var className = toString.call(a);

// 如果 a 和 b 类型不相同,则返回 false
// 类型都不同了还比较个蛋!
if (className !== toString.call(b)) return false;

switch (className) {
// Strings, numbers, regular expressions, dates, and booleans are compared by value.
// 以上五种类型的元素可以直接根据其 value 值来比较是否相等
case '[object RegExp]':
// RegExps are coerced to strings for comparison (Note: '' + /a/i === '/a/i')
case '[object String]':
// Primitives and their corresponding object wrappers are equivalent; thus, `"5"` is
// equivalent to `new String("5")`.
// 转为 String 类型进行比较
return '' + a === '' + b;

// RegExp 和 String 可以看做一类
// 如果 obj 为 RegExp 或者 String 类型
// 那么 '' + obj 会将 obj 强制转为 String
// 根据 '' + a === '' + b 即可判断 a 和 b 是否相等
// ================

case '[object Number]':
// `NaN`s are equivalent, but non-reflexive.
// Object(NaN) is equivalent to NaN
// 如果 +a !== +a
// 那么 a 就是 NaN
// 判断 b 是否也是 NaN 即可
if (+a !== +a) return +b !== +b;

// An `egal` comparison is performed for other numeric values.
// 排除了 NaN 干扰
// 还要考虑 0 的干扰
// 用 +a 将 Number() 形式转为基本类型
// 即 +Number(1) ==> 1
// 0 需要特判
// 如果 a 为 0,判断 1 / +a === 1 / b
// 否则判断 +a === +b
return +a === 0 ? 1 / +a === 1 / b : +a === +b;

// 如果 a 为 Number 类型
// 要注意 NaN 这个 special number
// NaN 和 NaN 被认为 equal
// ================

case '[object Date]':
case '[object Boolean]':
// Coerce dates and booleans to numeric primitive values. Dates are compared by their
// millisecond representations. Note that invalid dates with millisecond representations
// of `NaN` are not equivalent.
return +a === +b;

// Date 和 Boolean 可以看做一类
// 如果 obj 为 Date 或者 Boolean
// 那么 +obj 会将 obj 转为 Number 类型
// 然后比较即可
// +new Date() 是当前时间距离 1970 年 1 月 1 日 0 点的毫秒数
// +true => 1
// +new Boolean(false) => 0
}


// 判断 a 是否是数组
var areArrays = className === '[object Array]';

// 如果 a 不是数组类型
if (!areArrays) {
// 如果 a 不是 object 或者 b 不是 object
// 则返回 false
if (typeof a != 'object' || typeof b != 'object') return false;

// 通过上个步骤的 if 过滤
// !!保证到此的 a 和 b 均为对象!!

// Objects with different constructors are not equivalent, but `Object`s or `Array`s
// from different frames are.
// 通过构造函数来判断 a 和 b 是否相同
// 但是,如果 a 和 b 的构造函数不同
// 也并不一定 a 和 b 就是 unequal
// 比如 a 和 b 在不同的 iframes 中!
// aCtor instanceof aCtor 这步有点不大理解,啥用?
var aCtor = a.constructor, bCtor = b.constructor;
if (aCtor !== bCtor && !(_.isFunction(aCtor) && aCtor instanceof aCtor &&
_.isFunction(bCtor) && bCtor instanceof bCtor)
&& ('constructor' in a && 'constructor' in b)) {
return false;
}
}

// Assume equality for cyclic structures. The algorithm for detecting cyclic
// structures is adapted from ES 5.1 section 15.12.3, abstract operation `JO`.

// Initializing stack of traversed objects.
// It's done here since we only need them for objects and arrays comparison.
// 第一次调用 eq() 函数,没有传入 aStack 和 bStack 参数
// 之后递归调用都会传入这两个参数
aStack = aStack || [];
bStack = bStack || [];

var length = aStack.length;

while (length--) {
// Linear search. Performance is inversely proportional to the number of
// unique nested structures.
if (aStack[length] === a) return bStack[length] === b;
}

// Add the first object to the stack of traversed objects.
aStack.push(a);
bStack.push(b);

// Recursively compare objects and arrays.
// 将嵌套的对象和数组展开
// 如果 a 是数组
// 因为嵌套,所以需要展开深度比较
if (areArrays) {
// Compare array lengths to determine if a deep comparison is necessary.
// 根据 length 判断是否应该继续递归对比
length = a.length;

// 如果 a 和 b length 属性大小不同
// 那么显然 a 和 b 不同
// return false 不用继续比较了
if (length !== b.length) return false;

// Deep compare the contents, ignoring non-numeric properties.
while (length--) {
// 递归
if (!eq(a[length], b[length], aStack, bStack)) return false;
}
} else {
// 如果 a 不是数组
// 进入这个判断分支

// Deep compare objects.
// 两个对象的深度比较
var keys = _.keys(a), key;
length = keys.length;

// Ensure that both objects contain the same number of properties before comparing deep equality.
// a 和 b 对象的键数量不同
// 那还比较毛?
if (_.keys(b).length !== length) return false;

while (length--) {
// Deep compare each member
// 递归比较
key = keys[length];
if (!(_.has(b, key) && eq(a[key], b[key], aStack, bStack))) return false;
}
}

// Remove the first object from the stack of traversed objects.
// 与 aStack.push(a) 对应
// 此时 aStack 栈顶元素正是 a
// 而代码走到此步
// a 和 b isEqual 确认
// 所以 a,b 两个元素可以出栈
aStack.pop();
bStack.pop();

// 深度搜索递归比较完毕
// 放心地 return true
return true;
};

// Perform a deep comparison to check if two objects are equal.
// 判断两个对象是否一样
// new Boolean(true),true 被认为 equal
// [1, 2, 3], [1, 2, 3] 被认为 equal
// 0 和 -0 被认为 unequal
// NaN 和 NaN 被认为 equal
_.isEqual = function(a, b) {
return eq(a, b);
};

// Is a given array, string, or object empty?
// An "empty" object has no enumerable own-properties.
// 是否是 {}、[] 或者 "" 或者 null、undefined
_.isEmpty = function(obj) {
if (obj == null) return true;

// 如果是数组、类数组、或者字符串
// 根据 length 属性判断是否为空
// 后面的条件是为了过滤 isArrayLike 对于 {length: 10} 这样对象的判断 bug?
if (isArrayLike(obj) && (_.isArray(obj) || _.isString(obj) || _.isArguments(obj))) return obj.length === 0;

// 如果是对象
// 根据 keys 数量判断是否为 Empty
return _.keys(obj).length === 0;
};


// Is a given value a DOM element?
// 判断是否为 DOM 元素
_.isElement = function(obj) {
// 确保 obj 不是 null, undefined 等假值
// 并且 obj.nodeType === 1
return !!(obj && obj.nodeType === 1);
};

// Is a given value an array?
// Delegates to ECMA5's native Array.isArray
// 判断是否为数组
_.isArray = nativeIsArray || function(obj) {
return toString.call(obj) === '[object Array]';
};

// Is a given variable an object?
// 判断是否为对象
// 这里的对象包括 function 和 object
_.isObject = function(obj) {
var type = typeof obj;
return type === 'function' || type === 'object' && !!obj;
};

// Add some isType methods: isArguments, isFunction, isString, isNumber, isDate, isRegExp, isError.
// 其他类型判断
_.each(['Arguments', 'Function', 'String', 'Number', 'Date', 'RegExp', 'Error'], function(name) {
_['is' + name] = function(obj) {
return toString.call(obj) === '[object ' + name + ']';
};
});

// Define a fallback version of the method in browsers (ahem, IE < 9), where
// there isn't any inspectable "Arguments" type.
// _.isArguments 方法在 IE < 9 下的兼容
// IE < 9 下对 arguments 调用 Object.prototype.toString.call 方法
// 结果是 => [object Object]
// 而并非我们期望的 [object Arguments]。
// so 用是否含有 callee 属性来做兼容
if (!_.isArguments(arguments)) {
_.isArguments = function(obj) {
return _.has(obj, 'callee');
};
}

// Optimize `isFunction` if appropriate. Work around some typeof bugs in old v8,
// IE 11 (#1621), and in Safari 8 (#1929).
// _.isFunction 在 old v8, IE 11 和 Safari 8 下的兼容
// 觉得这里有点问题
// 我用的 chrome 49 (显然不是 old v8)
// 却也进入了这个 if 判断内部
if (typeof /./ != 'function' && typeof Int8Array != 'object') {
_.isFunction = function(obj) {
return typeof obj == 'function' || false;
};
}

// Is a given object a finite number?
// 判断是否是有限的数字
_.isFinite = function(obj) {
return isFinite(obj) && !isNaN(parseFloat(obj));
};

// Is the given value `NaN`? (NaN is the only number which does not equal itself).
// 判断是否是 NaN
// NaN 是唯一的一个 `自己不等于自己` 的 number 类型
// 这样写有 BUG
// _.isNaN(new Number(0)) => true
// 详见 https://github.com/hanzichi/underscore-analysis/issues/13
// 最新版本(edge 版)已经修复该 BUG
_.isNaN = function(obj) {
return _.isNumber(obj) && obj !== +obj;
};

// Is a given value a boolean?
// 判断是否是布尔值
// 基础类型(true、 false)
// 以及 new Boolean() 两个方向判断
// 有点多余了吧?
// 个人觉得直接用 toString.call(obj) 来判断就可以了
_.isBoolean = function(obj) {
return obj === true || obj === false || toString.call(obj) === '[object Boolean]';
};

// Is a given value equal to null?
// 判断是否是 null
_.isNull = function(obj) {
return obj === null;
};

// Is a given variable undefined?
// 判断是否是 undefined
// undefined 能被改写 (IE < 9)
// undefined 只是全局对象的一个属性
// 在局部环境能被重新定义
// 但是「void 0」始终是 undefined
_.isUndefined = function(obj) {
return obj === void 0;
};

// Shortcut function for checking if an object has a given property directly
// on itself (in other words, not on a prototype).
// 判断对象中是否有指定 key
// own properties, not on a prototype
_.has = function(obj, key) {
// obj 不能为 null 或者 undefined
return obj != null && hasOwnProperty.call(obj, key);
};


// Utility Functions
// 工具类方法
// 共 14 个扩展方法
// -----------------

// Run Underscore.js in *noConflict* mode, returning the `_` variable to its
// previous owner. Returns a reference to the Underscore object.
// 如果全局环境中已经使用了 `_` 变量
// 可以用该方法返回其他变量
// 继续使用 underscore 中的方法
// var underscore = _.noConflict();
// underscore.each(..);
_.noConflict = function() {
root._ = previousUnderscore;
return this;
};

// Keep the identity function around for default iteratees.
// 返回传入的参数,看起来好像没什么卵用
// 其实 _.identity 在 undescore 内大量作为迭代函数出现
// 能简化很多迭代函数的书写
_.identity = function(value) {
return value;
};

// Predicate-generating functions. Often useful outside of Underscore.
_.constant = function(value) {
return function() {
return value;
};
};

_.noop = function(){};

// 传送门
/*
var property = function(key) {
return function(obj) {
return obj == null ? void 0 : obj[key];
};
};
*/
_.property = property;

// Generates a function for a given object that returns a given property.
_.propertyOf = function(obj) {
return obj == null ? function(){} : function(key) {
return obj[key];
};
};

// Returns a predicate for checking whether an object has a given set of
// `key:value` pairs.
// 判断一个给定的对象是否有某些键值对
_.matcher = _.matches = function(attrs) {
attrs = _.extendOwn({}, attrs);
return function(obj) {
return _.isMatch(obj, attrs);
};
};

// Run a function **n** times.
// 执行某函数 n 次
_.times = function(n, iteratee, context) {
var accum = Array(Math.max(0, n));
iteratee = optimizeCb(iteratee, context, 1);
for (var i = 0; i < n; i++)
accum[i] = iteratee(i);
return accum;
};

// Return a random integer between min and max (inclusive).
// 返回一个 [min, max] 范围内的任意整数
_.random = function(min, max) {
if (max == null) {
max = min;
min = 0;
}
return min + Math.floor(Math.random() * (max - min + 1));
};

// A (possibly faster) way to get the current timestamp as an integer.
// 返回当前时间的 "时间戳"(单位 ms)
// 其实并不是时间戳,时间戳还要除以 1000(单位 s)
// +new Date 类似
_.now = Date.now || function() {
return new Date().getTime();
};

// List of HTML entities for escaping.
// HTML 实体编码
// escapeMap 用于编码
// see @http://www.cnblogs.com/zichi/p/5135636.html
// in PHP, htmlspecialchars — Convert special characters to HTML entities
// see @http://php.net/manual/zh/function.htmlspecialchars.php
// 能将 & " ' < > 转为实体编码(下面的前 5 种)
var escapeMap = {
'&': '&amp;',
'<': '&lt;',
'>': '&gt;',
'"': '&quot;',
// 以上四个为最常用的字符实体
// 也是仅有的可以在所有环境下使用的实体字符(其他应该用「实体数字」,如下)
// 浏览器也许并不支持所有实体名称(对实体数字的支持却很好)
"'": '&#x27;',
'`': '&#x60;'
};

// _.invert 方法将一个对象的键值对对调
// unescapeMap 用于解码
var unescapeMap = _.invert(escapeMap);

// Functions for escaping and unescaping strings to/from HTML interpolation.
var createEscaper = function(map) {
var escaper = function(match) {
return map[match];
};

// Regexes for identifying a key that needs to be escaped
// 正则替换
// 注意下 ?:
var source = '(?:' + _.keys(map).join('|') + ')';

// 正则 pattern
var testRegexp = RegExp(source);

// 全局替换
var replaceRegexp = RegExp(source, 'g');
return function(string) {
string = string == null ? '' : '' + string;
return testRegexp.test(string) ? string.replace(replaceRegexp, escaper) : string;
};
};

// Escapes a string for insertion into HTML, replacing &, <, >, ", `, and ' characters.
// 编码,防止被 XSS 攻击等一些安全隐患
_.escape = createEscaper(escapeMap);

// The opposite of escape
// replaces &amp;, &lt;, &gt;, &quot;, &#96; and &#x27; with their unescaped counterparts
// 解码
_.unescape = createEscaper(unescapeMap);

// If the value of the named `property` is a function then invoke it with the
// `object` as context; otherwise, return it.
_.result = function(object, property, fallback) {
var value = object == null ? void 0 : object[property];
if (value === void 0) {
value = fallback;
}
return _.isFunction(value) ? value.call(object) : value;
};

// Generate a unique integer id (unique within the entire client session).
// Useful for temporary DOM ids.
// 生成客户端临时的 DOM ids
var idCounter = 0;
_.uniqueId = function(prefix) {
var id = ++idCounter + '';
return prefix ? prefix + id : id;
};

// By default, Underscore uses ERB-style template delimiters, change the
// following template settings to use alternative delimiters.
// ERB => Embedded Ruby
// Underscore 默认采用 ERB-style 风格模板,也可以根据自己习惯自定义模板
// 1. <% %> - to execute some code
// 2. <%= %> - to print some value in template
// 3. <%- %> - to print some values HTML escaped
_.templateSettings = {
// 三种渲染模板
evaluate : /<%([\s\S]+?)%>/g,
interpolate : /<%=([\s\S]+?)%>/g,
escape : /<%-([\s\S]+?)%>/g
};

// When customizing `templateSettings`, if you don't want to define an
// interpolation, evaluation or escaping regex, we need one that is
// guaranteed not to match.
var noMatch = /(.)^/;

// Certain characters need to be escaped so that they can be put into a
// string literal.
var escapes = {
"'": "'",
'\\': '\\',
'\r': 'r', // 回车符
'\n': 'n', // 换行符
// http://stackoverflow.com/questions/16686687/json-stringify-and-u2028-u2029-check
'\u2028': 'u2028', // Line separator
'\u2029': 'u2029' // Paragraph separator
};

// RegExp pattern
var escaper = /\\|'|\r|\n|\u2028|\u2029/g;

var escapeChar = function(match) {
/**
' => \\'
\\ => \\\\
\r => \\r
\n => \\n
\u2028 => \\u2028
\u2029 => \\u2029
**/
return '\\' + escapes[match];
};

// 将 JavaScript 模板编译为可以用于页面呈现的函数
// JavaScript micro-templating, similar to John Resig's implementation.
// Underscore templating handles arbitrary delimiters, preserves whitespace,
// and correctly escapes quotes within interpolated code.
// NB: `oldSettings` only exists for backwards compatibility.
// oldSettings 参数为了兼容 underscore 旧版本
// setting 参数可以用来自定义字符串模板(但是 key 要和 _.templateSettings 中的相同,才能 overridden)
// 1. <% %> - to execute some code
// 2. <%= %> - to print some value in template
// 3. <%- %> - to print some values HTML escaped
// Compiles JavaScript templates into functions
// _.template(templateString, [settings])
_.template = function(text, settings, oldSettings) {
// 兼容旧版本
if (!settings && oldSettings)
settings = oldSettings;

// 相同的 key,优先选择 settings 对象中的
// 其次选择 _.templateSettings 对象中的
// 生成最终用来做模板渲染的字符串
// 自定义模板优先于默认模板 _.templateSettings
// 如果定义了相同的 key,则前者会覆盖后者
settings = _.defaults({}, settings, _.templateSettings);

// Combine delimiters into one regular expression via alternation.
// 正则表达式 pattern,用于正则匹配 text 字符串中的模板字符串
// /<%-([\s\S]+?)%>|<%=([\s\S]+?)%>|<%([\s\S]+?)%>|$/g
// 注意最后还有个 |$
var matcher = RegExp([
// 注意下 pattern 的 source 属性
(settings.escape || noMatch).source,
(settings.interpolate || noMatch).source,
(settings.evaluate || noMatch).source
].join('|') + '|$', 'g');

// Compile the template source, escaping string literals appropriately.
// 编译模板字符串,将原始的模板字符串替换成函数字符串
// 用拼接成的函数字符串生成函数(new Function(...))
var index = 0;

// source 变量拼接的字符串用来生成函数
// 用于当做 new Function 生成函数时的函数字符串变量
// 记录编译成的函数字符串,可通过 _.template(tpl).source 获取(_.template(tpl) 返回方法)
var source = "__p+='";

// replace 函数不需要为返回值赋值,主要是为了在函数内对 source 变量赋值
// 将 text 变量中的模板提取出来
// match 为匹配的整个串
// escape/interpolate/evaluate 为匹配的子表达式(如果没有匹配成功则为 undefined)
// offset 为字符匹配(match)的起始位置(偏移量)
text.replace(matcher, function(match, escape, interpolate, evaluate, offset) {
// \n => \\n
source += text.slice(index, offset).replace(escaper, escapeChar);

// 改变 index 值,为了下次的 slice
index = offset + match.length;

if (escape) {
// 需要对变量进行编码(=> HTML 实体编码)
// 避免 XSS 攻击
source += "'+\n((__t=(" + escape + "))==null?'':_.escape(__t))+\n'";
} else if (interpolate) {
// 单纯的插入变量
source += "'+\n((__t=(" + interpolate + "))==null?'':__t)+\n'";
} else if (evaluate) {
// 可以直接执行的 JavaScript 语句
// 注意 "__p+=",__p 为渲染返回的字符串
source += "';\n" + evaluate + "\n__p+='";
}

// Adobe VMs need the match returned to produce the correct offset.
// return 的作用是?
// 将匹配到的内容原样返回(Adobe VMs 需要返回 match 来使得 offset 值正常)
return match;
});

source += "';\n";

// By default, `template` places the values from your data in the local scope via the `with` statement.
// However, you can specify a single variable name with the variable setting.
// This can significantly improve the speed at which a template is able to render.
// If a variable is not specified, place data values in local scope.
// 指定 scope
// 如果设置了 settings.variable,能显著提升模板的渲染速度
// 否则,默认用 with 语句指定作用域
if (!settings.variable)
source = 'with(obj||{}){\n' + source + '}\n';

// 增加 print 功能
// __p 为返回的字符串
source = "var __t,__p='',__j=Array.prototype.join," +
"print=function(){__p+=__j.call(arguments,'');};\n" +
source + 'return __p;\n';

try {
// render 方法,前两个参数为 render 方法的参数
// obj 为传入的 JSON 对象,传入 _ 参数使得函数内部能用 Underscore 的函数
var render = new Function(settings.variable || 'obj', '_', source);
} catch (e) {
// 抛出错误
e.source = source;
throw e;
}

// 返回的函数
// data 一般是 JSON 数据,用来渲染模板
var template = function(data) {
// render 为模板渲染函数
// 传入参数 _ ,使得模板里 <% %> 里的代码能用 underscore 的方法
//(<% %> - to execute some code)
return render.call(this, data, _);
};

// Provide the compiled source as a convenience for precompilation.
// template.source for debug?
// obj 与 with(obj||{}) 中的 obj 对应
var argument = settings.variable || 'obj';

// 可通过 _.template(tpl).source 获取
// 可以用来预编译,在服务端预编译好,直接在客户端生成代码,客户端直接调用方法
// 这样如果出错就能打印出错行
// Precompiling your templates can be a big help when debugging errors you can't reproduce.
// This is because precompiled templates can provide line numbers and a stack trace,
// something that is not possible when compiling templates on the client.
// The source property is available on the compiled template function for easy precompilation.
// see @http://stackoverflow.com/questions/18755292/underscore-js-precompiled-templates-using
// see @http://stackoverflow.com/questions/13536262/what-is-javascript-template-precompiling
// see @http://stackoverflow.com/questions/40126223/can-anyone-explain-underscores-precompilation-in-template
// JST is a server-side thing, not client-side.
// This mean that you compile Unserscore template on server side by some server-side script and save the result in a file.
// Then use this file as compiled Unserscore template.
template.source = 'function(' + argument + '){\n' + source + '}';

return template;
};

// Add a "chain" function. Start chaining a wrapped Underscore object.
// 使支持链式调用
/**
// 非 OOP 调用 chain
_.chain([1, 2, 3])
.map(function(a) { return a * 2; })
.reverse().value(); // [6, 4, 2]
// OOP 调用 chain
_([1, 2, 3])
.chain()
.map(function(a){ return a * 2; })
.first()
.value(); // 2
**/
_.chain = function(obj) {
// 无论是否 OOP 调用,都会转为 OOP 形式
// 并且给新的构造对象添加了一个 _chain 属性
var instance = _(obj);

// 标记是否使用链式操作
instance._chain = true;

// 返回 OOP 对象
// 可以看到该 instance 对象除了多了个 _chain 属性
// 其他的和直接 _(obj) 的结果一样
return instance;
};

// OOP
// ---------------
// If Underscore is called as a function, it returns a wrapped object that
// can be used OO-style. This wrapper holds altered versions of all the
// underscore functions. Wrapped objects may be chained.

// OOP
// 如果 `_` 被当做方法(构造函数)调用, 则返回一个被包装过的对象
// 该对象能使用 underscore 的所有方法
// 并且支持链式调用

// Helper function to continue chaining intermediate results.
// 一个帮助方法(Helper function)
var result = function(instance, obj) {
// 如果需要链式操作,则对 obj 运行 _.chain 方法,使得可以继续后续的链式操作
// 如果不需要,直接返回 obj
return instance._chain ? _(obj).chain() : obj;
};

// Add your own custom functions to the Underscore object.
// 可向 underscore 函数库扩展自己的方法
// obj 参数必须是一个对象(JavaScript 中一切皆对象)
// 且自己的方法定义在 obj 的属性上
// 如 obj.myFunc = function() {...}
// 形如 {myFunc: function(){}}
// 之后便可使用如下: _.myFunc(..) 或者 OOP _(..).myFunc(..)
_.mixin = function(obj) {
// 遍历 obj 的 key,将方法挂载到 Underscore 上
// 其实是将方法浅拷贝到 _.prototype 上
_.each(_.functions(obj), function(name) {
// 直接把方法挂载到 _[name] 上
// 调用类似 _.myFunc([1, 2, 3], ..)
var func = _[name] = obj[name];

// 浅拷贝
// 将 name 方法挂载到 _ 对象的原型链上,使之能 OOP 调用
_.prototype[name] = function() {
// 第一个参数
var args = [this._wrapped];

// arguments 为 name 方法需要的其他参数
push.apply(args, arguments);
// 执行 func 方法
// 支持链式操作
return result(this, func.apply(_, args));
};
});
};

// Add all of the Underscore functions to the wrapper object.
// 将前面定义的 underscore 方法添加给包装过的对象
// 即添加到 _.prototype 中
// 使 underscore 支持面向对象形式的调用
_.mixin(_);

// Add all mutator Array functions to the wrapper.
// 将 Array 原型链上有的方法都添加到 underscore 中
_.each(['pop', 'push', 'reverse', 'shift', 'sort', 'splice', 'unshift'], function(name) {
var method = ArrayProto[name];
_.prototype[name] = function() {
var obj = this._wrapped;
method.apply(obj, arguments);

if ((name === 'shift' || name === 'splice') && obj.length === 0)
delete obj[0];

// 支持链式操作
return result(this, obj);
};
});

// Add all accessor Array functions to the wrapper.
// 添加 concat、join、slice 等数组原生方法给 Underscore
_.each(['concat', 'join', 'slice'], function(name) {
var method = ArrayProto[name];
_.prototype[name] = function() {
return result(this, method.apply(this._wrapped, arguments));
};
});

// Extracts the result from a wrapped and chained object.
// 一个包装过(OOP)并且链式调用的对象
// 用 value 方法获取结果
// _(obj).value === obj?
_.prototype.value = function() {
return this._wrapped;
};

// Provide unwrapping proxy for some methods used in engine operations
// such as arithmetic and JSON stringification.
_.prototype.valueOf = _.prototype.toJSON = _.prototype.value;

_.prototype.toString = function() {
return '' + this._wrapped;
};

// AMD registration happens at the end for compatibility with AMD loaders
// that may not enforce next-turn semantics on modules. Even though general
// practice for AMD registration is to be anonymous, underscore registers
// as a named module because, like jQuery, it is a base library that is
// popular enough to be bundled in a third party lib, but not be part of
// an AMD load request. Those cases could generate an error when an
// anonymous define() is called outside of a loader request.
// 兼容 AMD 规范
if (typeof define === 'function' && define.amd) {
define('underscore', [], function() {
return _;
});
}
}.call(this));