Natural StringSorting Test

src/TheNaturalStringSortingKata/NaturalStringSorting.cs

@@ -8,19 +8,38 @@
 
 namespace TDD_Katas_project.TheNaturalStringSortingKata
 {
+    /// <summary>
+    ///  Natural String Sorting
+    /// </summary>
     public class NaturalStringSorting
     {
-        #region Member variables
+        /// <summary>
+        /// 
+        /// </summary>
         public enum SortOrder
         {
-            Ascending, Descending
+            /// <summary>
+            /// The ascending
+            /// </summary>
+            Ascending,
+            /// <summary>
+            /// The descending
+            /// </summary>
+            Descending
         }
-        #endregion
-
-        #region Public Methods
 
+        /// <summary>
+        /// Sorts the string.
+        /// </summary>
+        /// <param name="strItems">The string items.</param>
+        /// <returns></returns>
         public List<string> SortString(string[] strItems) => SortString(strItems, SortOrder.Ascending);
-
+        /// <summary>
+        /// Sorts the string.
+        /// </summary>
+        /// <param name="strItems">The string items.</param>
+        /// <param name="order">The order.</param>
+        /// <returns></returns>
         public List<string> SortString(string[] strItems, SortOrder order)
         {
             Func<string, object> Convert = str =>
@@ -38,9 +57,6 @@ public List<string> SortString(string[] strItems, SortOrder order)
             return GetSortedList(strItems, order, Convert);
 
         }
-        #endregion
-
-        #region Private Method
 
         private static List<string> GetSortedList(IEnumerable<string> strItems, SortOrder order, Func<string, object> convert)
         {
@@ -60,7 +76,5 @@ private static List<string> GetSortedList(IEnumerable<string> strItems, SortOrde
             }
             return sorted;
         }
-
-        #endregion
     }
 }

src/TheNaturalStringSortingKata/NaturalStringSortingTest.cs

@@ -6,39 +6,49 @@
 
 namespace TDD_Katas_project.TheNaturalStringSortingKata
 {
+    /// <summary>
+    /// Natural StringSorting Test
+    /// </summary>
     [TestFixture]
     [Category("The Natural String Kata")]
     public class NaturalStringSortingTest
     {
-        #region Private Member Variables
+
         private NaturalStringSorting _naturalStringSorting;
         private string[] _strings;
-        #endregion
 
-        #region Setup/TearDown
+                /// <summary>
+        /// Setups this instance.
+        /// </summary>
         [SetUp]
         public void Setup()
         {
             _naturalStringSorting = new NaturalStringSorting();
             _strings = new[] { "a1", "1", "3", "2", "b1", "1a", "b3", "23", "z 21", "21 1", "z22", "0" };
         }
+        /// <summary>
+        /// Tears down.
+        /// </summary>
         [TearDown]
         public void TearDown()
         {
             _naturalStringSorting = null;
             _strings = null;
         }
-        #endregion
-
-        #region Test Methods
 
+        /// <summary>
+        /// Determines whether this instance [can sort string default order].
+        /// </summary>
         [Test]
         public void CanSortStringDefaultOrder()
         {
             var sortString = _naturalStringSorting.SortString(_strings);
             string[] result = { "0", "1", "1a", "2", "3", "23", "21 1", "a1", "b1", "b3", "z 21", "z22" };
             Assert.That(sortString, Is.EqualTo(ToList(result)));
         }
+        /// <summary>
+        /// Determines whether this instance [can sort string DES order].
+        /// </summary>
         [Test]
         public void CanSortStringDesOrder()
         {
@@ -47,11 +57,8 @@ public void CanSortStringDesOrder()
             Assert.That(sortString, Is.EqualTo(ToList(result)));
 
         }
-        #endregion
-
-        #region Private Methods
+
         private static List<string> ToList(params string[] items) => items.ToList();
 
-        #endregion
     }
 }