Apply suggestions from code review

Co-authored-by: Jeremy Barton <[email protected]>

Author: adamsitnik

src/libraries/System.Runtime.Serialization.BinaryFormat/src/System/Runtime/Serialization/BinaryFormat/ArrayRecord.cs

@@ -63,7 +63,7 @@ private protected ArrayRecord(ArrayInfo arrayInfo)
     ///   otherwise, <see langword="false" />.
     /// </param>
     /// <returns>An array filled with the data provided in the serialized records.</returns>
-    /// <exception cref="InvalidOperationException"><paramref name="expectedArrayType" /> does not match the data from payload.</exception>
+    /// <exception cref="InvalidOperationException"><paramref name="expectedArrayType" /> does not match the data from the payload.</exception>
     [RequiresDynamicCode("The code for an array of the specified type might not be available.")]
     public Array GetArray(Type expectedArrayType, bool allowNulls = true)
     {

src/libraries/System.Runtime.Serialization.BinaryFormat/src/System/Runtime/Serialization/BinaryFormat/ArraySinglePrimitiveRecord.cs

@@ -83,7 +83,7 @@ internal static IReadOnlyList<T> DecodePrimitiveTypes(BinaryReader reader, int c
 
         // Most of the tests use MemoryStream or FileStream and they both allow for executing the fast path.
         // To ensure the slow path is tested as well, the fast path is executed only for optimized builds.
-#if NETCOREAPP
+#if NET
         if (typeof(T) != typeof(decimal) && typeof(T) != typeof(DateTime) && typeof(T) != typeof(TimeSpan) // not optimized
             && reader.IsDataAvailable(count * Unsafe.SizeOf<T>()))
         {
@@ -165,7 +165,7 @@ private static List<T> DecodePrimitiveTypesToList(BinaryReader reader, int count
         return values;
     }
 
-#if NETCOREAPP
+#if NET
     private static T[] DecodePrimitiveTypesToArray(BinaryReader reader, int count)
     {
         T[] result = new T[count];

src/libraries/System.Runtime.Serialization.BinaryFormat/src/System/Runtime/Serialization/BinaryFormat/ObjectNullMultipleRecord.cs

@@ -22,6 +22,9 @@ internal sealed class ObjectNullMultipleRecord : NullsRecord
 
     internal static ObjectNullMultipleRecord Decode(BinaryReader reader)
     {
+        // 2.5.5 ObjectNullMultiple
+        
+        // NullCount (4 bytes): An INT32 value ... The value MUST be a positive integer.
         int count = reader.ReadInt32();
         if (count <= 0)
         {

src/libraries/System.Runtime.Serialization.BinaryFormat/src/System/Runtime/Serialization/BinaryFormat/PrimitiveTypeRecord.cs

@@ -12,7 +12,7 @@ namespace System.Runtime.Serialization.BinaryFormat;
 /// <remarks>
 /// <para>
 /// The NRBF specification considers the following types to be primitive:
-/// <see langword="string"/>, <see cref="bool"/>, <see cref="byte"/>, <see cref="sbyte"/>
+/// <see cref="String"/>, <see cref="bool"/>, <see cref="byte"/>, <see cref="sbyte"/>
 /// <see cref="char"/>, <see cref="short"/>, <see cref="ushort"/>,
 /// <see cref="int"/>, <see cref="uint"/>, <see cref="long"/>, <see cref="ulong"/>,
 /// <see cref="float"/>, <see cref="double"/>, <see cref="decimal"/>,

src/libraries/System.Runtime.Serialization.BinaryFormat/src/System/Runtime/Serialization/BinaryFormat/RecordType.cs

@@ -24,10 +24,12 @@ enum RecordType : byte
     /// </summary>
     SerializedStreamHeader = 0,
     /// <summary>
-    /// A class information that references another class record's metadata.
+    /// Class information that references another class record's metadata.
     /// </summary>
     ClassWithId = 1,
+    
     // SystemClassWithMembers and ClassWithMembers are not supported by design (require type loading)
+    
     /// <summary>
     /// A system class information with type info.
     /// </summary>
@@ -41,7 +43,7 @@ enum RecordType : byte
     /// </summary>
     BinaryObjectString = 6,
     /// <summary>
-    /// An array other than single dimensional array of primitive types and <see cref="object" />.
+    /// An array of any rank or element type.
     /// </summary>
     BinaryArray = 7,
     /// <summary>
@@ -53,19 +55,19 @@ enum RecordType : byte
     /// </summary>
     MemberReference = 9,
     /// <summary>
-    /// A <see langword="null" />.
+    /// A single <see langword="null" /> value.
     /// </summary>
     ObjectNull = 10,
     /// <summary>
     /// The record that marks the end of the binary format stream.
     /// </summary>
     MessageEnd = 11,
     /// <summary>
-    /// A library is a named unit that contains a collection of types.
+    /// A record that associates a numeric identifier with a named library.
     /// </summary>
     BinaryLibrary = 12,
     /// <summary>
-    /// Multiple (less than 256) <see langword="null" />.
+    /// Multiple (less than 256) <see langword="null" /> values.
     /// </summary>
     ObjectNullMultiple256 = 13,
     /// <summary>
@@ -77,11 +79,11 @@ enum RecordType : byte
     /// </summary>
     ArraySinglePrimitive = 15,
     /// <summary>
-    /// A single dimensional array of <see cref="object" />.
+    /// A single-dimensional array of <see cref="object" /> values.
     /// </summary>
     ArraySingleObject = 16,
     /// <summary>
-    /// A single dimensional array of <see langword="string" />.
+    /// A single-dimensional array of <see langword="string" /> values.
     /// </summary>
     ArraySingleString = 17
 }

src/libraries/System.Runtime.Serialization.BinaryFormat/src/System/Runtime/Serialization/BinaryFormat/RectangularOrCustomOffsetArrayRecord.cs

@@ -28,13 +28,13 @@ private RectangularOrCustomOffsetArrayRecord(Type elementType, ArrayInfo arrayIn
         // A List<T> can hold as many objects as an array, so for multi-dimensional arrays
         // with more elements than Array.MaxLength we use LinkedList.
         // Testing that many elements takes a LOT of time, so to ensure that both code paths are tested,
-        // we always use LinkedList code path for non-Release builds.
-#if RELEASE
+        // we always use LinkedList code path for Debug builds.
+#if DEBUG
+        _values = new LinkedList<object>();
+#else
         _values = arrayInfo.TotalElementsCount <= ArrayInfo.MaxArrayLength
             ? new List<object>(canPreAllocate ? arrayInfo.GetSZArrayLength() : Math.Min(4, arrayInfo.GetSZArrayLength()))
             : new LinkedList<object>();
-#else
-        _values = new LinkedList<object>();
 #endif
 
     }

src/libraries/System.Runtime.Serialization.BinaryFormat/src/System/Runtime/Serialization/BinaryFormat/SerializationRecord.cs

@@ -48,7 +48,7 @@ internal SerializationRecord() // others can't derive from this type
     /// <para>This method does NOT take into account member names or their types.</para>
     /// </remarks>
     /// <param name="type">The type to compare against.</param>
-    /// <returns>True if the serialized type and assembly name match provided type.</returns>
+    /// <returns><see langword="true" /> if the serialized type and assembly name match provided type; otherwise, <see langword="false" />.</returns>
     public virtual bool IsTypeNameMatching(Type type) => false;
 
     /// <summary>