Merge pull request #482 from ikesnowy/dev

3.1 Finished

Author: ikesnowy

1 Fundamental/1.2/Commercial/Date.cs

@@ -2,16 +2,32 @@
 
 namespace Commercial
 {
+    /// <summary>
+    /// 日期类。
+    /// </summary>
     public class Date : IComparable<Date>
     {
-        public int Month { get; }   // 月
-        public int Day { get; }     // 日
-        public int Year { get; }    // 年
+        /// <summary>
+        /// 月份。
+        /// </summary>
+        /// <value>月份数据。</value>
+        public int Month { get; }
+        /// <summary>
+        /// 日期。
+        /// </summary>
+        /// <value>日期数据。</value>
+        public int Day { get; }
+        /// <summary>
+        /// 年份。
+        /// </summary>
+        /// <value>年份数据。</value>
+        public int Year { get; }
 
         /// <summary>
         /// 构造函数。
         /// </summary>
         /// <param name="date">形如 "05/31/2017" 的字符串。</param>
+        /// <exception cref="ArgumentException">输入日期格式不正确时抛出异常。</exception>
         public Date(string date)
         {
             string[] a = date.Split('/');
@@ -36,9 +52,9 @@ public Date(int m, int d, int y)
         }
 
         /// <summary>
-        /// 返回形如 05/22/2017 的字符串。
+        /// 将日期转换成字符串，格式为 dd/mm/yyyy。
         /// </summary>
-        /// <returns></returns>
+        /// <returns>形如 05/22/2017 的字符串。</returns>
         public override string ToString()
         {
             return this.Month + "/" + this.Day + "/" + this.Year;
@@ -48,7 +64,7 @@ public override string ToString()
         /// 比较两个日期是否相同。
         /// </summary>
         /// <param name="obj">需要比较的另一个对象。</param>
-        /// <returns></returns>
+        /// <returns>相等返回 <c>true</c>，否则返回 <c>false</c>。</returns>
         public override bool Equals(object obj)
         {
             if (obj == this)
@@ -64,7 +80,7 @@ public override bool Equals(object obj)
         /// <summary>
         /// 获取日期的哈希值。
         /// </summary>
-        /// <returns></returns>
+        /// <returns>日期的哈希值。</returns>
         public override int GetHashCode()
         {
             int hash = 17;
@@ -78,7 +94,7 @@ public override int GetHashCode()
         /// 比较两个日期的先后。
         /// </summary>
         /// <param name="other">另一个日期。</param>
-        /// <returns></returns>
+        /// <returns><paramref name="other"/> 较后时返回大于 0 的数，反之返回小于 0 的数，相等返回 0。</returns>
         public int CompareTo(Date other)
         {
             if (this.Year > other.Year)

1 Fundamental/1.2/Commercial/Transaction.cs

@@ -3,10 +3,26 @@
 
 namespace Commercial
 {
+    /// <summary>
+    /// 交易记录类。
+    /// </summary>
     public class Transaction : IComparable<Transaction>
     {
+        /// <summary>
+        /// 客户姓名。
+        /// </summary>
+        /// <value>客户姓名。</value>
         public string Who { get; }
+        /// <summary>
+        /// 交易日期。
+        /// </summary>
+        /// <value>交易日期。</value>
+        /// <seealso cref="Date"/>
         public Date When { get; }
+        /// <summary>
+        /// 交易金额。
+        /// </summary>
+        /// <value>交易金额。</value>
         public double Amount { get; }
 
         /// <summary>
@@ -66,6 +82,12 @@ public int CompareTo(Transaction other)
         /// </summary>
         public class WhoOrder : IComparer<Transaction>
         {
+            /// <summary>
+            /// 比较两个 <see cref="Transaction"/> 的姓名。
+            /// </summary>
+            /// <param name="x">需要比较的第一个记录。</param>
+            /// <param name="y">需要比较的第二个记录。</param>
+            /// <returns><paramref name="x"/> 姓名靠后时返回大于 0 的数，反之返回小于 0 的数，相等返回 0。</returns>
             int IComparer<Transaction>.Compare(Transaction x, Transaction y)
             {
                 return x.Who.CompareTo(y.Who);
@@ -77,6 +99,12 @@ int IComparer<Transaction>.Compare(Transaction x, Transaction y)
         /// </summary>
         public class WhenOrder : IComparer<Transaction>
         {
+            /// <summary>
+            /// 比较两个 <see cref="Transaction"/> 的交易时间。
+            /// </summary>
+            /// <param name="x">需要比较的第一个记录。</param>
+            /// <param name="y">需要比较的第二个记录。</param>
+            /// <returns><paramref name="x"/> 时间靠后时返回大于 0 的数，反之返回小于 0 的数，相等返回 0。</returns>
             int IComparer<Transaction>.Compare(Transaction x, Transaction y)
             {
                 return x.When.CompareTo(y.When);
@@ -88,6 +116,12 @@ int IComparer<Transaction>.Compare(Transaction x, Transaction y)
         /// </summary>
         public class HowMuchOrder : IComparer<Transaction>
         {
+            /// <summary>
+            /// 比较两个 <see cref="Transaction"/> 的交易金额。
+            /// </summary>
+            /// <param name="x">需要比较的第一个记录。</param>
+            /// <param name="y">需要比较的第二个记录。</param>
+            /// <returns><paramref name="x"/> 金额较大时返回大于 0 的数，反之返回小于 0 的数，相等返回 0。</returns>
             int IComparer<Transaction>.Compare(Transaction x, Transaction y)
             {
                 return x.Amount.CompareTo(y.Amount);
@@ -118,7 +152,7 @@ public override bool Equals(object obj)
         /// <summary>
         /// 返回交易信息的哈希值。
         /// </summary>
-        /// <returns></returns>
+        /// <returns>交易信息的哈希值。</returns>
         public override int GetHashCode()
         {
             int hash = 1;

1 Fundamental/1.2/Geometry/Interval1D.cs

@@ -9,11 +9,33 @@ namespace Geometry
     /// </summary>
     public class Interval1D
     {
+        /// <summary>
+        /// 优先以起点升序排序，起点相同时按照终点升序排序。
+        /// </summary>
+        /// <value>优先以起点升序排序，起点相同时按照终点升序排序。</value>
         public static readonly Comparer<Interval1D> Min_Order = new MinEndpointComparer();
+        /// <summary>
+        /// 优先以终点升序排序，起点相同时按照起点升序排序。
+        /// </summary>
+        /// <value>优先以终点升序排序，起点相同时按照起点升序排序。</value>
         public static readonly Comparer<Interval1D> Max_Order = new MaxEndpointComparer();
+        /// <summary>
+        /// 以区间长度升序排序。
+        /// </summary>
+        /// <value>以区间长度升序排序。</value>
         public static readonly Comparer<Interval1D> Length_Order = new LengthComparer();
 
+        /// <summary>
+        /// 区间起点。
+        /// </summary>
+        /// <value>区间起点。</value>
+        /// <remarks>这个属性是只读的。</remarks>
         public double Min { get; }
+        /// <summary>
+        /// 区间终点。
+        /// </summary>
+        /// <value>区间终点。</value>
+        /// <remarks>这个属性是只读的。</remarks>
         public double Max { get; }
 
         /// <summary>
@@ -56,7 +78,7 @@ public double Length()
         /// 判断目标区间是否被本区间包含。
         /// </summary>
         /// <param name="that">需要判断是否被包含的区间。</param>
-        /// <returns></returns>
+        /// <returns>若 <paramref name="that"/> 被本区间包含则返回 <c>true</c>，否则返回 <c>false</c>。</returns>
         public bool Contains(Interval1D that)
         {
             return this.Min < that.Min && this.Max > that.Max;
@@ -66,7 +88,7 @@ public bool Contains(Interval1D that)
         /// 目标值是否处在区域内。如果目标值在区域内则返回 True，否则返回 False。
         /// </summary>
         /// <param name="x">需要判断的值。</param>
-        /// <returns></returns>
+        /// <returns>若 <paramref name="x"/> 被本区间包含则返回 <c>true</c>，否则返回 <c>false</c>。</returns>
         public bool Contains(double x)
         {
             return x >= this.Min && x <= this.Max;
@@ -100,7 +122,7 @@ public void Draw(Graphics g, int y)
         /// <summary>
         /// 将区域转换为 string，返回形如 "[lo, hi]" 的字符串。
         /// </summary>
-        /// <returns></returns>
+        /// <returns>形如 "[<see cref="Min"/>, <see cref="Max"/>]" 的字符串。</returns>
         public override string ToString()
         {
             string s = "[" + this.Min + ", " + this.Max + "]";
@@ -111,7 +133,7 @@ public override string ToString()
         /// 判断两个区间是否相等。
         /// </summary>
         /// <param name="obj">相比较的区间。</param>
-        /// <returns></returns>
+        /// <returns>如果区间相等则返回 <c>true</c>，否则返回 <c>false</c>。</returns>
         public override bool Equals(object obj)
         {
             if (obj == this)
@@ -133,7 +155,7 @@ public override bool Equals(object obj)
         /// <summary>
         /// 返回区间的哈希代码。
         /// </summary>
-        /// <returns></returns>
+        /// <returns>返回区间的哈希代码。</returns>
         public override int GetHashCode()
         {
             int hash1 = this.Min.GetHashCode();

1 Fundamental/1.2/Geometry/Interval2D.cs

@@ -25,7 +25,7 @@ public Interval2D(Interval1D x, Interval1D y)
         /// 判断两个平面是否相交。
         /// </summary>
         /// <param name="that">需要判断的另一个平面。</param>
-        /// <returns></returns>
+        /// <returns>相交则返回 <c>true</c>，否则返回 <c>false</c>。</returns>
         public bool Intersects(Interval2D that)
         {
             if (!this.X.Intersect(that.X))
@@ -45,7 +45,7 @@ public bool Intersects(Interval2D that)
         /// 判断目标区间是否被本区间包含。
         /// </summary>
         /// <param name="that">需要判断是否被包含的区间。</param>
-        /// <returns></returns>
+        /// <returns>如果 <paramref name="that"/> 被包含，则返回 <c>true</c>，否则返回 <c>false</c>。</returns>
         public bool Contains(Interval2D that)
         {
             return this.X.Contains(that.X) && this.Y.Contains(that.Y);
@@ -55,7 +55,7 @@ public bool Contains(Interval2D that)
         /// 判断一个二维点是否在该平面范围内。
         /// </summary>
         /// <param name="p">需要判断的二维点。</param>
-        /// <returns></returns>
+        /// <returns>如果 <paramref name="p"/> 被包含，则返回 <c>true</c>，否则 <c>false</c>。</returns>
         public bool Contains(Point2D p)
         {
             return (this.X.Contains(p.X) && this.Y.Contains(p.Y));
@@ -64,7 +64,7 @@ public bool Contains(Point2D p)
         /// <summary>
         /// 计算平面范围的面积。
         /// </summary>
-        /// <returns></returns>
+        /// <returns>平面范围的面积。</returns>
         public double Area()
         {
             return this.X.Length() * this.Y.Length();
@@ -84,7 +84,7 @@ public void Draw(Graphics g)
         /// <summary>
         /// 返回形如“[xmin, xmax] x [ymin, ymax]”的字符串。
         /// </summary>
-        /// <returns></returns>
+        /// <returns>形如 "[xmin, xmax] x [ymin, ymax]" 的字符串。</returns>
         public override string ToString()
         {
             return this.X + "x" + this.Y;
@@ -94,7 +94,7 @@ public override string ToString()
         /// 判断两个二维区间是否相等。
         /// </summary>
         /// <param name="obj">需要比较的另一个区间。</param>
-        /// <returns></returns>
+        /// <returns>相等则返回 <c>true</c>，否则返回 <c>false</c>。</returns>
         public override bool Equals(object obj)
         {
             if (obj == this)
@@ -119,7 +119,7 @@ public override bool Equals(object obj)
         /// <summary>
         /// 获取哈希值
         /// </summary>
-        /// <returns></returns>
+        /// <returns>2D 区间的哈希值。</returns>
         public override int GetHashCode()
         {
             int hash1 = this.X.GetHashCode();