Added comments to BulkLoader

Author: Jason Valdez

src/ivaldez.SqlBulkLoader/BulkLoader.cs

@@ -15,11 +15,18 @@ public class BulkLoader : IBulkLoader
     {
         private readonly ISqlBulkCopyUtility _sqlBulkCopyUtility;
 
+        /// <summary>
+        /// Constructor that uses default SqlBulkCopyUtility class.
+        /// </summary>
         public BulkLoader()
         {
             _sqlBulkCopyUtility = new SqlBulkCopyUtility();
         }
 
+        /// <summary>
+        /// Constructor with SQL BulkCopy Utility. Interface allows for extension and testing. 
+        /// </summary>
+        /// <param name="sqlBulkCopyUtility"></param>
         public BulkLoader(ISqlBulkCopyUtility sqlBulkCopyUtility)
         {
             _sqlBulkCopyUtility = sqlBulkCopyUtility;
@@ -121,35 +128,10 @@ public void Insert<T>(string tableName,
             }
         }
 
-        private void BulkCopyWithNoBatching<T>(string tableName, SqlConnection conn, IEnumerable<T> dataToInsert,
-            SqlBulkCopyOptions options, TargetProperty[] targetProperties)
-        {
-            _sqlBulkCopyUtility.BulkCopy(tableName, conn, options, targetProperties, dataToInsert);
-        }
-
-        private void BulkCopyWithBatching<T>(string tableName, SqlConnection conn, IEnumerable<T> dataToInsert, int batchSize,
-            SqlBulkCopyOptions options, TargetProperty[] targetProperties)
-        {
-            var batch = new List<T>(batchSize);
-
-            foreach (var item in dataToInsert)
-            {
-                batch.Add(item);
-
-                if (batch.Count >= batchSize)
-                {
-                    _sqlBulkCopyUtility.BulkCopy(tableName, conn, options, targetProperties, batch);
-                    batch.Clear();
-                }
-            }
-
-            if (batch.Any())
-            {
-                _sqlBulkCopyUtility.BulkCopy(tableName, conn, options, targetProperties, batch);
-                batch.Clear();
-            }
-        }
-
+        /// <summary>
+        /// SqlBulkCopyUtility wraps the basic functionality for bulkCopy. The interface is provided so that
+        /// the basic class can be extended if necessary, as well as for testing.
+        /// </summary>
         public class SqlBulkCopyUtility: ISqlBulkCopyUtility
         {
             public void BulkCopy<T>(string tableName, SqlConnection conn, SqlBulkCopyOptions options,
@@ -176,6 +158,10 @@ public void BulkCopy<T>(string tableName, SqlConnection conn, SqlBulkCopyOptions
             }
         }
 
+        /// <summary>
+        /// SqlBulkCopyUtility wraps the basic functionality for bulkCopy. The interface is provided so that
+        /// the basic class can be extended if necessary, as well as for testing.
+        /// </summary>
         public interface ISqlBulkCopyUtility
         {
             void BulkCopy<T>(string tableName, SqlConnection conn, SqlBulkCopyOptions options,
@@ -190,6 +176,35 @@ public class TargetProperty
             public string OriginalName { get; set; }
         }
 
+        private void BulkCopyWithNoBatching<T>(string tableName, SqlConnection conn, IEnumerable<T> dataToInsert,
+            SqlBulkCopyOptions options, TargetProperty[] targetProperties)
+        {
+            _sqlBulkCopyUtility.BulkCopy(tableName, conn, options, targetProperties, dataToInsert);
+        }
+
+        private void BulkCopyWithBatching<T>(string tableName, SqlConnection conn, IEnumerable<T> dataToInsert, int batchSize,
+            SqlBulkCopyOptions options, TargetProperty[] targetProperties)
+        {
+            var batch = new List<T>(batchSize);
+
+            foreach (var item in dataToInsert)
+            {
+                batch.Add(item);
+
+                if (batch.Count >= batchSize)
+                {
+                    _sqlBulkCopyUtility.BulkCopy(tableName, conn, options, targetProperties, batch);
+                    batch.Clear();
+                }
+            }
+
+            if (batch.Any())
+            {
+                _sqlBulkCopyUtility.BulkCopy(tableName, conn, options, targetProperties, batch);
+                batch.Clear();
+            }
+        }
+
         private static TargetProperty[] GetTargetProperties<T>(List<string> propertiesToIgnore,
             Dictionary<string, string> renameFields)
         {
@@ -220,6 +235,9 @@ private static TargetProperty[] GetTargetProperties<T>(List<string> propertiesTo
         }
     }
 
+    /// <summary>
+    /// Factory class used to create default instances of the BulkLoader
+    /// </summary>
     public class BulkLoaderFactory
     {
         public static IBulkLoader Create()