Add sample code

kochounoyume · Jan 6, 2025 · baa3514 · baa3514
1 parent ce92d6c
commit baa3514
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 1 deletion.
diff --git a/Packages/MinimalUtility/Runtime/EqualityComparer.cs b/Packages/MinimalUtility/Runtime/EqualityComparer.cs
@@ -13,6 +13,39 @@ public static class EqualityComparer
         /// <summary>
         /// 指定した比較処理を使用して<see cref="EqualityComparer{T}"/>を生成します.
         /// </summary>
+        ///<example>
+        ///<code>
+        /// <![CDATA[
+        /// using System.Collections.Generic;
+        /// using MinimalUtility;
+        ///
+        /// public enum Fruits : int
+        /// {
+        ///     Apple,
+        ///     Orange,
+        ///     Banana,
+        /// }
+        ///
+        /// public class EqualityComparerFactoryExample
+        /// {
+        ///     private readonly Dictionary<Fruits, string> _fruits;
+        ///
+        ///     public EqualityComparerFactoryExample()
+        ///     {
+        ///         var equalityComparer = EqualityComparer.Create<Fruits>(
+        ///             static (x, y) => (int) x == (int) y,
+        ///             static x => ((int) x).GetHashCode());
+        ///         _fruits = new Dictionary<Fruits, string>(3, equalityComparer)
+        ///         {
+        ///             {Fruits.Apple, "Apple"},
+        ///             {Fruits.Orange, "Orange"},
+        ///             {Fruits.Banana, "Banana"},
+        ///         };
+        ///     }
+        /// }
+        /// ]]>
+        /// </code>
+        /// </example>
         /// <param name="equals"><see cref="EqualityComparer{T}.Equals(T, T)"/>に使用する処理.</param>
         /// <param name="getHashCode"><see cref="EqualityComparer{T}.GetHashCode(T)"/>に使用する処理.</param>
         /// <typeparam name="T">比較対象の型.</typeparam>

diff --git a/Packages/MinimalUtility/Runtime/UnityExtension/ComponentExtensions.cs b/Packages/MinimalUtility/Runtime/UnityExtension/ComponentExtensions.cs
@@ -89,7 +89,7 @@ public static ReadOnlyMemory<T> GetComponentsInOnlyChildren<T>(this Component se
         ///
         /// public class SafeGetComponentExample : MonoBehaviour
         /// {
-        ///     private HingeJoint hinge;
+        ///     private HingeJoint _hinge;
         ///
         ///     private void Update()
         ///     {