Skip to content

Commit e70eb4f

Browse files
CodePlayerCodePlayer
committed
fix(util): 修正已知的注释格式和拼写错误
1 parent 314f08a commit e70eb4f

File tree

15 files changed

+125
-125
lines changed

15 files changed

+125
-125
lines changed

‎src/main/java/me/codeplayer/util/Arith.java‎

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -13,20 +13,20 @@
1313
public class Arith {
1414

1515
// constant
16-
/** 表示数值 0(零) 的BigDecimal */
16+
/** 表示数值 0(零) 的 BigDecimal */
1717
public static final BigDecimal ZERO = BigDecimal.ZERO;
18-
/** 表示数值 1(一) 的BigDecimal */
18+
/** 表示数值 1(一) 的 BigDecimal */
1919
public static final BigDecimal ONE = BigDecimal.ONE;
20-
/** 表示数值 10(一十) 的BigDecimal */
20+
/** 表示数值 10(一十) 的 BigDecimal */
2121
public static final BigDecimal TEN = BigDecimal.TEN;
22-
/** 表示数值 100(一百) 的BigDecimal */
22+
/** 表示数值 100(一百) 的 BigDecimal */
2323
public static final BigDecimal HUNDRED = new BigDecimal(100);
24-
/** 表示数值 1000(一千) 的BigDecimal */
24+
/** 表示数值 1000(一千) 的 BigDecimal */
2525
public static final BigDecimal THOUSAND = new BigDecimal(1000);
26-
/** 表示数值 10 000(一万) 的BigDecimal */
26+
/** 表示数值 10 000(一万) 的 BigDecimal */
2727
public static final BigDecimal MYRIAD = new BigDecimal(10000);
28-
/** 表示数值 100 000 000(一亿) 的BigDecimal */
29-
public static final BigDecimal HANDRED_MILLION = new BigDecimal(10000_0000);
28+
/** 表示数值 100 000 000(一亿) 的 BigDecimal */
29+
public static final BigDecimal HUNDRED_MILLION = new BigDecimal(10000_0000);
3030
// property
3131
protected BigDecimal value;
3232

@@ -59,14 +59,14 @@ public Arith(BigInteger val) {
5959
}
6060

6161
/**
62-
* 构造一个指定long值的商业计算数
62+
* 构造一个指定 long 值的商业计算数
6363
*/
6464
public Arith(long d) {
6565
value = toBigDecimal(d);
6666
}
6767

6868
/**
69-
* 构造一个指定boolean值的商业计算数。 boolean值true=1，false=0
69+
* 构造一个指定 boolean 值的商业计算数。 boolean 值 true=1，false=0
7070
*/
7171
public Arith(boolean b) {
7272
this.value = b ? BigDecimal.ONE : BigDecimal.ZERO;
@@ -411,56 +411,56 @@ public BigDecimal value() {
411411
}
412412

413413
/**
414-
* 转换为BigInteger
414+
* 转换为 BigInteger
415415
*/
416416
public BigInteger toBigInteger() {
417417
return value.toBigInteger();
418418
}
419419

420420
/**
421-
* 转换为double值
421+
* 转换为 double 值
422422
*/
423423
public double doubleValue() {
424424
return value.doubleValue();
425425
}
426426

427427
/**
428-
* 转换为四舍五入精确到指定小数位的double值
428+
* 转换为四舍五入精确到指定小数位的 double 值
429429
*/
430430
public double doubleValue(int scale) {
431431
return value.setScale(scale, RoundingMode.HALF_UP).doubleValue();
432432
}
433433

434434
/**
435-
* 转换为int值
435+
* 转换为 int 值
436436
*/
437437
public int intValue() {
438438
return value.intValue();
439439
}
440440

441441
/**
442-
* 转换为long值
442+
* 转换为 long 值
443443
*/
444444
public long longValue() {
445445
return value.longValue();
446446
}
447447

448448
/**
449-
* 转换为float值
449+
* 转换为 float 值
450450
*/
451451
public float floatValue() {
452452
return value.floatValue();
453453
}
454454

455455
/**
456-
* 转换为byte值
456+
* 转换为 byte 值
457457
*/
458458
public byte byteValue() {
459459
return value.byteValue();
460460
}
461461

462462
/**
463-
* 转换为short值
463+
* 转换为 short 值
464464
*/
465465
public short shortValue() {
466466
return value.shortValue();
@@ -521,7 +521,7 @@ public static double multiply(double a, double b, int scale) {
521521
/**
522522
* 商业乘法运算(四舍五入)<br>
523523
* <strong>注意：</strong>此方法的有效位数包含整数部分在内<br>
524-
* 将precision设为long类型只是为了重载的需要
524+
* 将 precision 设为 long 类型只是为了重载的需要
525525
*
526526
* @param a 乘数1
527527
* @param b 乘数2
@@ -603,7 +603,7 @@ public static long floorToLong(double d) {
603603
}
604604

605605
/**
606-
* 判断两个数值a和b的大小
606+
* 判断两个数值 a 和 b 的大小
607607
*
608608
* @return 如果：
609609
* <ul>
@@ -617,7 +617,7 @@ public static int compareTo(BigDecimal a, BigDecimal b) {
617617
}
618618

619619
/**
620-
* 判断两个数值a和b的大小
620+
* 判断两个数值 a 和 b 的大小
621621
*
622622
* @return 如果：
623623
* <ul>
@@ -631,7 +631,7 @@ public static int compareTo(BigDecimal a, double b) {
631631
}
632632

633633
/**
634-
* 判断两个数值a和b的大小
634+
* 判断两个数值 a 和 b 的大小
635635
*
636636
* @return 如果：
637637
* <ul>
@@ -645,7 +645,7 @@ public static int compareTo(BigDecimal a, long b) {
645645
}
646646

647647
/**
648-
* 判断两个数值a和b的大小
648+
* 判断两个数值 a 和 b 的大小
649649
*
650650
* @return 如果：
651651
* <ul>
@@ -659,7 +659,7 @@ public static int compareTo(BigDecimal a, String b) {
659659
}
660660

661661
/**
662-
* 检测指定的BigDecimal是否为整数值
662+
* 检测指定的 BigDecimal 是否为整数值
663663
*
664664
* @author Ready
665665
*/
@@ -707,7 +707,7 @@ public String toString(int scale) {
707707
}
708708

709709
/**
710-
* 构造一个指定Object值的商业计算数
710+
* 构造一个指定 Object 值的商业计算数
711711
*/
712712
public static Arith valueOf(Object value) throws NullPointerException {
713713
if (value instanceof Number) {
@@ -728,7 +728,7 @@ public static Arith valueOf(Object value) throws NullPointerException {
728728
}
729729

730730
/**
731-
* 构造一个指定Object值的商业计算数
731+
* 构造一个指定 Object 值的商业计算数
732732
*/
733733
public static Arith valueOfOrZero(@Nullable Object value) {
734734
return value == null ? new Arith(BigDecimal.ZERO) : valueOf(value);
@@ -737,7 +737,7 @@ public static Arith valueOfOrZero(@Nullable Object value) {
737737
/**
738738
* 将指定的 double 转换为对应的 BigDecimal
739739
* <p>
740-
* 如果是整数，会自动进行优化处理，避免 new BigDedimal(Double.toString(val)) 的字符串转换及解析开销
740+
* 如果是整数，会自动进行优化处理，避免 new BigDecimal(Double.toString(val)) 的字符串转换及解析开销
741741
*
742742
* @since 4.0.0
743743
*/
@@ -766,7 +766,7 @@ public static BigDecimal toBigDecimal(int n) {
766766
case 10000:
767767
return MYRIAD;
768768
case 100000000:
769-
return HANDRED_MILLION;
769+
return HUNDRED_MILLION;
770770
default:
771771
return BigDecimal.valueOf(n);
772772
}

‎src/main/java/me/codeplayer/util/ArrayX.java‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ public static String join(Object array, String delimiter) {
9292
* 如果数组为空，将会引发异常 <br>
9393
* 如果存在数组元素，则拼接内容形如 " IN (1, 2, 5)" 或 " IN ('1', '2', '5')"
9494
*
95-
* @param sb 指定的StringBuilder
95+
* @param sb 指定的 StringBuilder
9696
* @param array 指定的任意数组
9797
* @param isInclude 指示IN SQL是包含还是排除查询，如果是包含(true)将返回 IN，如果是排除(false)将返回 NOT IN
9898
* @param isString 指示元素是否以字符串形式参与in SQL语句。如果为true，将会在每个元素两侧加上单引号"'"
@@ -173,7 +173,7 @@ public static String toString(Object array) {
173173
* 迭代数组元素并将迭代字符串追加至StringBuilder中,追加字符串形如：“[e1, e2, e3, [e4_1, e4_2, e4_3, e4_4]]<br>
174174
* 本方法可以迭代多维数组，内部采用递归算法
175175
*
176-
* @param sb 指定的StringBuilder
176+
* @param sb 指定的 StringBuilder
177177
* @param array 指定的数组对象
178178
*/
179179
public static StringBuilder toFinalString(StringBuilder sb, Object array) {
@@ -576,14 +576,14 @@ public static <E> E[] filter(final E[] array, final Predicate<? super E> matcher
576576
*/
577577
@SafeVarargs
578578
public static <E> E[] filter(final Predicate<? super E> matcher, final E... array) {
579-
final E[] newAarray = array.clone();
579+
final E[] newArray = array.clone();
580580
int count = 0;
581-
for (E e : newAarray) {
581+
for (E e : newArray) {
582582
if (matcher.test(e)) {
583-
newAarray[count++] = e;
583+
newArray[count++] = e;
584584
}
585585
}
586-
return count == newAarray.length ? newAarray : Arrays.copyOf(newAarray, count);
586+
return count == newArray.length ? newArray : Arrays.copyOf(newArray, count);
587587
}
588588

589589
/**

‎src/main/java/me/codeplayer/util/Assert.java‎

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,10 @@
2323
public abstract class Assert {
2424

2525
/**
26-
* 断言布尔表达式结果为true<br>
26+
* 断言布尔表达式结果为 true<br>
2727
* 如果断言失败则抛出异常
2828
*
29-
* @param expression boolean表达式
29+
* @param expression boolean 表达式
3030
* @throws AssertException 如果断言失败
3131
*/
3232
public static void isTrue(final boolean expression) {
@@ -36,10 +36,10 @@ public static void isTrue(final boolean expression) {
3636
}
3737

3838
/**
39-
* 断言布尔表达式结果为true<br>
39+
* 断言布尔表达式结果为 true<br>
4040
* 如果断言失败则抛出异常
4141
*
42-
* @param expression boolean表达式
42+
* @param expression boolean 表达式
4343
* @param errorMsg 异常消息内容
4444
* @throws AssertException 如果断言失败
4545
*/
@@ -50,10 +50,10 @@ public static void isTrue(final boolean expression, final @Nullable CharSequence
5050
}
5151

5252
/**
53-
* 断言布尔表达式结果为true<br>
53+
* 断言布尔表达式结果为 true<br>
5454
* 如果断言失败则抛出异常
5555
*
56-
* @param expression boolean表达式
56+
* @param expression boolean 表达式
5757
* @param msger 异常消息内容
5858
* @throws AssertException 如果断言失败
5959
*/
@@ -64,10 +64,10 @@ public static void isTrue(final boolean expression, final @Nullable Supplier<? e
6464
}
6565

6666
/**
67-
* 断言布尔表达式结果为true<br>
67+
* 断言布尔表达式结果为 true<br>
6868
* 如果断言失败则抛出异常
6969
*
70-
* @param expression boolean表达式
70+
* @param expression boolean 表达式
7171
* @throws IllegalStateException 如果断言失败
7272
*/
7373
public static void state(final boolean expression) {
@@ -77,10 +77,10 @@ public static void state(final boolean expression) {
7777
}
7878

7979
/**
80-
* 断言布尔表达式结果为true<br>
80+
* 断言布尔表达式结果为 true<br>
8181
* 如果断言失败则抛出异常
8282
*
83-
* @param expression boolean表达式
83+
* @param expression boolean 表达式
8484
* @param errorMsg 异常消息内容
8585
* @throws IllegalStateException 如果断言失败
8686
*/
@@ -91,10 +91,10 @@ public static void state(final boolean expression, final @Nullable CharSequence
9191
}
9292

9393
/**
94-
* 断言布尔表达式结果为true<br>
94+
* 断言布尔表达式结果为 true<br>
9595
* 如果断言失败则抛出异常
9696
*
97-
* @param expression boolean表达式
97+
* @param expression boolean 表达式
9898
* @param msger 异常消息内容
9999
* @throws IllegalStateException 如果断言失败
100100
*/
@@ -108,18 +108,18 @@ public static void state(final boolean expression, final @Nullable Supplier<? ex
108108
* 断言布尔表达式结果为 false
109109
* 如果断言失败则抛出异常
110110
*
111-
* @param expression boolean表达式
111+
* @param expression boolean 表达式
112112
* @throws AssertException 如果断言失败
113113
*/
114114
public static void isFalse(final boolean expression) {
115115
isTrue(!expression);
116116
}
117117

118118
/**
119-
* 断言布尔表达式结果为false<br>
119+
* 断言布尔表达式结果为 false<br>
120120
* 如果断言失败则抛出异常
121121
*
122-
* @param expression boolean表达式
122+
* @param expression boolean 表达式
123123
* @param errorMsg 异常消息内容
124124
* @throws AssertException 如果断言失败
125125
*/
@@ -128,10 +128,10 @@ public static void isFalse(final boolean expression, final @Nullable CharSequenc
128128
}
129129

130130
/**
131-
* 断言布尔表达式结果为false<br>
131+
* 断言布尔表达式结果为 false<br>
132132
* 如果断言失败则抛出异常
133133
*
134-
* @param expression boolean表达式
134+
* @param expression boolean 表达式
135135
* @param msger 异常消息内容
136136
* @throws AssertException 如果断言失败
137137
*/
@@ -175,7 +175,7 @@ public static void isNull(@Nullable Object object, @Nullable Supplier<? extends
175175
}
176176

177177
/**
178-
* 断言指定对象不为null<br>
178+
* 断言指定对象不为 null<br>
179179
* 如果断言失败则抛出异常
180180
*
181181
* @param object 指定对象
@@ -190,7 +190,7 @@ public static <T> T notNull(@Nullable T object) throws NullPointerException {
190190
}
191191

192192
/**
193-
* 断言指定对象不为null<br>
193+
* 断言指定对象不为 null<br>
194194
* 如果断言失败则抛出异常
195195
*
196196
* @param obj 指定对象
@@ -206,7 +206,7 @@ public static <T> T notNull(final @Nullable T obj, final @Nullable CharSequence
206206
}
207207

208208
/**
209-
* 断言指定对象不为null<br>
209+
* 断言指定对象不为 null<br>
210210
* 如果断言失败则抛出异常
211211
*
212212
* @param obj 指定对象

‎src/main/java/me/codeplayer/util/ChineseNumber.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,12 +56,12 @@ protected StringBuilder appendIntValue(StringBuilder sb) {
5656
return sb.append(style.getNumbersText()[0]);
5757
}
5858
int length = number.length();
59-
// 计算cell的个数
59+
// 计算 cell 的个数
6060
int size = length >> 2;
6161
if (length % 4 != 0) {
6262
size++;
6363
}
64-
// 循环截取4位数字字符串组装成cell，放入List中
64+
// 循环截取 4 位数字字符串组装成 cell，放入 List 中
6565
List<Cell> cells = new ArrayList<>(size);
6666
do {
6767
int startIndex = length - 4;

0 commit comments

Comments
 (0)