docs: 完善 javadoc

src/main/java/xyz/zhouxy/plusone/commons/util/Numbers.java

@@ -23,7 +23,7 @@ import javax.annotation.Nonnull;
 import javax.annotation.Nullable;
 
 /**
- * Numbers
+ * 数字工具类
  *
  * @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
  */
@@ -31,6 +31,12 @@ public class Numbers {
 
     // #region - sum
 
+    /**
+     * 求和
+     *
+     * @param numbers 数据数组
+     * @return 求和结果
+     */
     public static int sum(final short... numbers) {
         int result = 0;
         for (short number : numbers) {
@@ -39,6 +45,12 @@ public class Numbers {
         return result;
     }
 
+    /**
+     * 求和
+     *
+     * @param numbers 数据数组
+     * @return 求和结果
+     */
     public static long sum(final int... numbers) {
         long result = 0L;
         for (int number : numbers) {
@@ -47,6 +59,12 @@ public class Numbers {
         return result;
     }
 
+    /**
+     * 求和
+     *
+     * @param numbers 数据数组
+     * @return 求和结果
+     */
     public static long sum(final long... numbers) {
         long result = 0L;
         for (long number : numbers) {
@@ -55,6 +73,12 @@ public class Numbers {
         return result;
     }
 
+    /**
+     * 求和
+     *
+     * @param numbers 数据数组
+     * @return 求和结果
+     */
     public static double sum(final float... numbers) {
         double result = 0.00;
         for (float number : numbers) {
@@ -63,6 +87,12 @@ public class Numbers {
         return result;
     }
 
+    /**
+     * 求和
+     *
+     * @param numbers 数据数组
+     * @return 求和结果
+     */
     public static double sum(final double... numbers) {
         double result = 0.00;
         for (double number : numbers) {
@@ -71,6 +101,12 @@ public class Numbers {
         return result;
     }
 
+    /**
+     * 求和
+     *
+     * @param numbers 数据数组
+     * @return 求和结果
+     */
     public static BigInteger sum(final BigInteger... numbers) {
         if (ArrayTools.isNullOrEmpty(numbers)) {
             return BigInteger.ZERO;
@@ -85,6 +121,12 @@ public class Numbers {
         return result;
     }
 
+    /**
+     * 求和
+     *
+     * @param numbers 数据数组
+     * @return 求和结果
+     */
     public static BigDecimal sum(final BigDecimal... numbers) {
         return BigDecimals.sum(numbers);
     }
@@ -93,35 +135,83 @@ public class Numbers {
 
     // #region - nullToZero
 
+    /**
+     * 将 {@code null} 转换为 {@code 0}
+     *
+     * @param val 待转换的值
+     * @return 如果 {@code val} 不为 {@code null}，则返回该值；如果值为 {@code null}，则返回 {@code 0}
+     */
     public static byte nullToZero(@Nullable final Byte val) {
         return val != null ? val : 0;
     }
 
+    /**
+     * 将 {@code null} 转换为 {@code 0}
+     *
+     * @param val 待转换的值
+     * @return 如果 {@code val} 不为 {@code null}，则返回该值；如果值为 {@code null}，则返回 {@code 0}
+     */
     public static short nullToZero(@Nullable final Short val) {
         return val != null ? val : 0;
     }
 
+    /**
+     * 将 {@code null} 转换为 {@code 0}
+     *
+     * @param val 待转换的值
+     * @return 如果 {@code val} 不为 {@code null}，则返回该值；如果值为 {@code null}，则返回 {@code 0}
+     */
     public static int nullToZero(@Nullable final Integer val) {
         return val != null ? val : 0;
     }
 
+    /**
+     * 将 {@code null} 转换为 {@code 0}
+     *
+     * @param val 待转换的值
+     * @return 如果 {@code val} 不为 {@code null}，则返回该值；如果值为 {@code null}，则返回 {@code 0}
+     */
     public static long nullToZero(@Nullable final Long val) {
         return val != null ? val : 0L;
     }
 
+    /**
+     * 将 {@code null} 转换为 {@code 0}
+     *
+     * @param val 待转换的值
+     * @return 如果 {@code val} 不为 {@code null}，则返回该值；如果值为 {@code null}，则返回 {@code 0}
+     */
     public static float nullToZero(@Nullable final Float val) {
         return val != null ? val : 0.0F;
     }
 
+    /**
+     * 将 {@code null} 转换为 {@code 0}
+     *
+     * @param val 待转换的值
+     * @return 如果 {@code val} 不为 {@code null}，则返回该值；如果值为 {@code null}，则返回 {@code 0}
+     */
     public static double nullToZero(@Nullable final Double val) {
         return val != null ? val : 0.0;
     }
 
+    /**
+     * 将 {@code null} 转换为 {@code 0}
+     *
+     * @param val 待转换的值
+     * @return 如果 {@code val} 不为 {@code null}，则返回该值；如果值为 {@code null}，则返回 {@code 0}
+     */
     @Nonnull
     public static BigInteger nullToZero(@Nullable final BigInteger val) {
         return val != null ? val : BigInteger.ZERO;
     }
 
+    /**
+     * 将 {@code null} 转换为 {@code 0}
+     *
+     * @param val 待转换的值
+     * @return 如果 {@code val} 不为 {@code null}，则返回该值；如果值为 {@code null}，则返回 {@code 0}
+     */
     @Nonnull
     public static BigDecimal nullToZero(@Nullable final BigDecimal val) {
         return BigDecimals.nullToZero(val);