Refine Comments in Samples

Clarify some existing comments, add additional comments, and clean up
some formatting.

Author: max-wilkinson

samples/Samples/Sample02_HandlingDynamicObject.cs

@@ -29,7 +29,7 @@
 namespace Samples
 {
 	/// <summary>
-	///		A sample code for explore MessagePackObject.
+	///	A sample code for explore MessagePackObject.
 	/// </summary>
 	[TestFixture]
 	public class HandlingDynamicObjectSample
@@ -91,7 +91,7 @@ public void SerializeThenDeserialize()
 			// byte[] is byte[], as you know.
 			Debug.WriteLine( "Image : {0}({1})", asDictionary[ "Image" ], asDictionary[ "Image" ].UnderlyingType );
 
-			// 4. Now MessagePackSerializer handle MessagePackObject directly.
+			// 4. Now MessagePackSerializer handles MessagePackObject directly.
 			var mpo = serializer.ToMessagePackObject( targetObject );
 			var asDictionary2 = mpo.AsDictionary();
 			Debug.WriteLine( "---- ToMessagePackObject ----" );
@@ -100,7 +100,7 @@ public void SerializeThenDeserialize()
 			Debug.WriteLine( "Date : {0}({1})", asDictionary2[ "Date" ], asDictionary2[ "Date" ].UnderlyingType );
 			Debug.WriteLine( "Image : {0}({1})", asDictionary2[ "Image" ], asDictionary2[ "Image" ].UnderlyingType );
 
-			// reversing
+			// 5. Use MessagePackSerializer to deserialize target object from MessagePackObject
 			var targetObject2 = serializer.FromMessagePackObject( mpo );
 			Debug.WriteLine( "---- FromMessagePackObject ----" );
 			Debug.WriteLine( "Id : {0}", targetObject2.Id );

samples/Samples/Sample03_SerializationContextAndOptions.cs

@@ -29,7 +29,7 @@
 namespace Samples
 {
 	/// <summary>
-	///		A sample code to describe SerializationContext usage.
+	///	A sample code to describe SerializationContext usage.
 	/// </summary>
 	[TestFixture]
 	public class SerializationContextAndOptionsSample

samples/Samples/Sample04_CustomSerializer.cs

@@ -29,7 +29,7 @@
 namespace Samples
 {
 	/// <summary>
-	///		A sample code to describe SerializationContext usage.
+	///	A sample code to describe SerializationContext usage.
 	/// </summary>
 	[TestFixture]
 	public class CustomSerializerSample
@@ -50,7 +50,7 @@ public void RegisterAndUseCustomSerializer()
 			// 3. Get a serializer instance with customized settings.
 			var serializer = MessagePackSerializer.Get<DateTime>( context );
 
-			// Test it.
+			// 4. Test Serialization and Deserialization.
 			var dateTime = DateTime.Now;
 			serializer.Pack( stream, dateTime );
 			stream.Position = 0;
@@ -61,7 +61,7 @@ public void RegisterAndUseCustomSerializer()
 	}
 
 	/// <summary>
-	///		A custom serializer sample: Serialize <see cref="System.DateTime"/> as UTC.
+	///	A custom serializer sample: Serialize <see cref="System.DateTime"/> as UTC.
 	/// </summary>
 	public class NetUtcDateTimeSerializer : MessagePackSerializer<DateTime>
 	{

samples/Samples/Sample05_PackableAndUnpackable.cs

@@ -29,7 +29,7 @@
 namespace Samples
 {
 	/// <summary>
-	///		A sample code to describe SerializationContext usage.
+	///	A sample code to describe SerializationContext usage.
 	/// </summary>
 	[TestFixture]
 	public class PackageAndUnpackableSample
@@ -51,11 +51,11 @@ public void RegisterAndUseCustomSerializer()
 	}
 
 	/// <summary>
-	///		A custom serializer sample: Serialize <see cref="System.DateTime"/> as UTC.
+	///	A custom serializer sample: Serialize <see cref="System.DateTime"/> as UTC.
 	/// </summary>
 	public class PackableUnpackableObject : IPackable, IUnpackable
 	{
-		// Imagine whien you cannot use auto-generated serializer so you have to implement custom serializer for own type easily.
+		// Imagine when you cannot use auto-generated serializer so you have to implement custom serializer for own type easily.
 		public long Id { get; set; }
 		public string Name { get; set; }
 

samples/Samples/Sample06_CustomAttributes.cs

@@ -26,8 +26,11 @@
 
 namespace Samples
 {
-	// You can tweak serialization behavior via custom attributes.
-	public class MessagePackMemberSample
+    /// <summary>
+    /// Sample code to describe MessagePackMember usage.
+    /// </summary>
+    /// <remarks>You can tweak serialization behavior via custom attributes.</remarks>
+    public class MessagePackMemberSample
 	{
 		[MessagePackMember(
 			0, // Specify 0 based index for serialized array. You should specify this value to ensure interoperability with other platform bindings.

samples/Samples/Sample07_ConstructorBasedDeserialization.cs

@@ -27,13 +27,13 @@
 namespace Samples
 {
 	/// <summary>
-	///		A sample to describe constructor related behavior.
+	///	A sample to describe constructor related behavior.
 	/// </summary>
 	[TestFixture]
 	public class ConstructorBasedDeserializationSample
 	{
 		/// <summary>
-		///		Demonstrates constructor based deserialization.
+		///	Demonstrates constructor based deserialization.
 		/// </summary>
 		[Test]
 		public void DoConstructorBasedDeserialization()
@@ -62,7 +62,7 @@ public void DoConstructorBasedDeserialization()
 	}
 
 	/// <summary>
-	///		"Record" class which has getters and parameterful constructor.
+	///	"Record" class which has getters and parameterful constructor.
 	/// </summary>
 	public class MySimpleRecordClass
 	{
@@ -75,8 +75,8 @@ public MySimpleRecordClass( string name )
 	}
 
 	/// <summary>
-	///		A example class which has getters and parameterless and parameterful constructor,
-	///		and the parameterful constructor is qualified with MessagePackDeserializationConstructor.
+	///	A example class which has getters and parameterless and parameterful constructor,
+	///	and the parameterful constructor is qualified with MessagePackDeserializationConstructor.
 	/// </summary>
 	public class MyComplexRecordClass
 	{

samples/Samples/Sample08_Polymorphism.cs

@@ -28,13 +28,13 @@
 namespace Samples
 {
 	/// <summary>
-	///		A sample to describe polymorphism.
+	///	A sample to describe polymorphism.
 	/// </summary>
 	[TestFixture]
 	public class PolymorphismSample
 	{
 		/// <summary>
-		///		Demonstrates basic polymorphism.
+		///	Demonstrates basic polymorphism.
 		/// </summary>
 		[Test]
 		public void Polymorphism()
@@ -78,7 +78,7 @@ public void Polymorphism()
 		}
 
 		/// <summary>
-		///		Demonstrates polymorphism without enclosing type and its attributes.
+		///	Demonstrates polymorphism without enclosing type and its attributes.
 		/// </summary>
 		[Test]
 		public void DirectPolymorphism()
@@ -153,40 +153,41 @@ public class PolymorphicHolder
 	}
 
 	/// <summary>
-	///		Sample base type.
+	///	Sample base type.
 	/// </summary>
 	public interface IFileSystemObject
 	{
 		string Path { get; set; }
 	}
 
 	/// <summary>
-	///		Sample derived type 1.
+	///	Sample derived type 1.
 	/// </summary>
 	public class FileObject : IFileSystemObject
 	{
 		public string Path { get; set; }
 	}
 
 	/// <summary>
-	///		Sample derived type 2.
+	///	Sample derived type 2.
 	/// </summary>
 	public class DirectoryObject : IFileSystemObject
 	{
 		public string Path { get; set; }
 	}
 
 	/// <summary>
-	///		Sample type verifier.
+	///	Sample type verifier.
 	/// </summary>
 	public static class SampleTypeVerifier
 	{
-		/// <summary>
-		///		Sample type verifier. The signature of this method is important.
-		/// </summary>
-		/// <param name="context">The context which has information of deserializing type.</param>
-		/// <returns>True for accepting; otherwise, false.</returns>
-		public static bool Verify( PolymorphicTypeVerificationContext context )
+        /// <summary>
+        ///	Sample type verifier.
+        /// </summary>
+        /// <remarks>The signature of this method is important.</remarks>
+        /// <param name="context">The context which has information of deserializing type.</param>
+        /// <returns>True for accepting; otherwise, false.</returns>
+        public static bool Verify( PolymorphicTypeVerificationContext context )
 		{
 			// You should put type verification logic to prevent unexpected code execution via specified type.
 			// 1. Check context.LoadingAssemblyName here to verify the assembly is known for you.

samples/Samples/Sample09_Async.cs

@@ -27,12 +27,15 @@
 
 namespace Samples
 {
-	[TestFixture]
+    /// <summary>
+    ///	A sample code to describe async methods.
+    /// </summary>
+    [TestFixture]
 	public class AsyncSample
 	{
-		/// <summary>
-		///		Demonstrates async methods.
-		/// </summary>
+        /// <summary>
+        /// Has object serialized and deserialized asynchronously.
+        /// </summary>
 		[Test]
 		public async Task RunAsync()
 		{

samples/Samples/Sample10_ByteArrayBased.cs

@@ -26,9 +26,15 @@
 
 namespace Samples
 {
+    /// <summary>
+    /// A sample code to describe byte array based behavior.
+    /// </summary>
 	[TestFixture]
 	public class Sample10_ByteArrayBased
 	{
+        /// <summary>
+        /// Uses byte array for serialization and deserialization.
+        /// </summary>
 		[Test]
 		public void SimpleBufferCase()
 		{