Merge pull request #85 from xkzhangsan/dev

修改注释
xkzhangsan · Jul 17, 2021 · 0cb0aff · 0cb0aff
2 parents 6139c5f + 7faf0d0
commit 0cb0aff
Show file tree

Hide file tree

Showing 4 changed files with 62 additions and 64 deletions.
diff --git a/src/main/java/com/xkzhangsan/time/calculator/DateTimeCalculatorUtil.java b/src/main/java/com/xkzhangsan/time/calculator/DateTimeCalculatorUtil.java
@@ -75,7 +75,7 @@
  * 25.中国工作日计算（将放假信息包含在内），包括判断当前日期是否为工作日和下一个工作日等方法， isChineseWorkDay*，nextChineseWorkDay*，比如isChineseWorkDay(Date, String holidayData)，nextChineseWorkDay(Date date, String holidayData)<br>
  * 节假日数据holidayData，如果节假日数据不支持年份，将使用周一到周五为工作日来判断<br>
  * 26.判断2个或多个时间段是否有重叠（交集）方法， isOverlap*，比如isOverlap(Date startDate1, Date endDate1, Date startDate2, Date endDate2)，重叠返回true。<br>
- * 27.计算平均时间方法，averageTime*，比如averageTime(List<Date> dateList)，返回平均时间，比如"15:03:03"。
+ * 27.计算平均时间方法，averageTime*，比如{@code averageTime(List<Date> dateList)}，返回平均时间，比如"15:03:03"。
  * 28.根据毫秒值计算倒计时方法，countdown*，比如countdown(long millis),返回倒计时，比如"27小时10分钟30秒"。
  *   
 * @author xkzhangsan
@@ -4082,7 +4082,7 @@ public static LocalTime averageTime(List<Date> dateList) {
 	/**
 	 * 根据毫秒值计算倒计时
 	 * @param millis 相差毫秒值
-	 * @return 返回倒计时，millis <= 0 返回：0小时0分钟0秒
+	 * @return 返回倒计时，millis 小于等于0 返回：0小时0分钟0秒
 	 */
 	public static String countdown(long millis){
 		if (millis <= 0) {
@@ -4102,7 +4102,7 @@ public static String countdown(long millis){
 	/**
 	 * 根据毫秒值计算倒计时，包含天数
 	 * @param millis 相差毫秒值
-	 * @return 返回倒计时，millis <= 0 返回：0天0小时0分钟0秒
+	 * @return 返回倒计时，millis 小于等于0 返回：0天0小时0分钟0秒
 	 */
 	public static String countdownWithDay(long millis){
 		if (millis <= 0) {

diff --git a/src/main/java/com/xkzhangsan/time/converter/DateTimeConverterUtil.java b/src/main/java/com/xkzhangsan/time/converter/DateTimeConverterUtil.java
@@ -742,7 +742,7 @@ public static BigDecimal unitConversionPrecise(long sourceDuration, TimeUnit sou
 
 	/**
 	 * 单位转换，天转小时
-	 * @param num
+	 * @param num 待转换值
 	 * @return 小时数
 	 */
 	public static long dayToHour(long num){
@@ -751,7 +751,7 @@ public static long dayToHour(long num){
 
 	/**
 	 * 单位转换，天转分钟
-	 * @param num
+	 * @param num 待转换值
 	 * @return 分钟数
 	 */
 	public static long dayToMinute(long num){
@@ -760,7 +760,7 @@ public static long dayToMinute(long num){
 
 	/**
 	 * 单位转换，天转秒
-	 * @param num
+	 * @param num 待转换值
 	 * @return 秒数
 	 */
 	public static long dayToSecond(long num){
@@ -769,7 +769,7 @@ public static long dayToSecond(long num){
 
 	/**
 	 * 单位转换，天转毫秒
-	 * @param num
+	 * @param num 待转换值
 	 * @return 毫秒数
 	 */
 	public static long dayToMillisecond(long num){
@@ -778,7 +778,7 @@ public static long dayToMillisecond(long num){
 
 	/**
 	 * 单位转换，小时转分钟
-	 * @param num
+	 * @param num 待转换值
 	 * @return 分钟数
 	 */
 	public static long hourToMinute(long num){
@@ -787,7 +787,7 @@ public static long hourToMinute(long num){
 
 	/**
 	 * 单位转换，小时转秒
-	 * @param num
+	 * @param num 待转换值
 	 * @return 秒数
 	 */
 	public static long hourToSecond(long num){
@@ -796,7 +796,7 @@ public static long hourToSecond(long num){
 
 	/**
 	 * 单位转换，小时转毫秒
-	 * @param num
+	 * @param num 待转换值
 	 * @return 毫秒数
 	 */
 	public static long hourToMillisecond(long num){
@@ -805,7 +805,7 @@ public static long hourToMillisecond(long num){
 
 	/**
 	 * 单位转换，小时转天
-	 * @param num
+	 * @param num 待转换值
 	 * @return 天数
 	 */
 	public static long hourToDay(long num){
@@ -814,7 +814,7 @@ public static long hourToDay(long num){
 
 	/**
 	 * 小时转天，精确计算，保留1位小数，ROUND_DOWN 舍去多余小数
-	 * @param num
+	 * @param num 待转换值
 	 * @return 天数，保留1位小数，ROUND_DOWN 舍去多余小数
 	 */
 	public static BigDecimal hourToDayPrecise(long num){
@@ -823,7 +823,7 @@ public static BigDecimal hourToDayPrecise(long num){
 
 	/**
 	 * 单位转换，分钟转秒
-	 * @param num
+	 * @param num 待转换值
 	 * @return 秒数
 	 */
 	public static long minuteToSecond(long num){
@@ -832,7 +832,7 @@ public static long minuteToSecond(long num){
 
 	/**
 	 * 单位转换，分钟转毫秒
-	 * @param num
+	 * @param num 待转换值
 	 * @return 毫秒数
 	 */
 	public static long minuteToMillisecond(long num){
@@ -841,7 +841,7 @@ public static long minuteToMillisecond(long num){
 
 	/**
 	 * 单位转换，分钟转小时
-	 * @param num
+	 * @param num 待转换值
 	 * @return 小时数
 	 */
 	public static long minuteToHour(long num){
@@ -850,7 +850,7 @@ public static long minuteToHour(long num){
 
 	/**
 	 * 分钟转小时，精确计算，保留1位小数，ROUND_DOWN 舍去多余小数
-	 * @param num
+	 * @param num 待转换值
 	 * @return 小时数，保留1位小数，ROUND_DOWN 舍去多余小数
 	 */
 	public static BigDecimal minuteToHourPrecise(long num){
@@ -859,7 +859,7 @@ public static BigDecimal minuteToHourPrecise(long num){
 
 	/**
 	 * 单位转换，分钟转天
-	 * @param num
+	 * @param num 待转换值
 	 * @return 天数
 	 */
 	public static long minuteToDay(long num){
@@ -868,7 +868,7 @@ public static long minuteToDay(long num){
 
 	/**
 	 * 分钟转天，精确计算，保留1位小数，ROUND_DOWN 舍去多余小数
-	 * @param num
+	 * @param num 待转换值
 	 * @return 天数，保留1位小数，ROUND_DOWN 舍去多余小数
 	 */
 	public static BigDecimal minuteToDayPrecise(long num){
@@ -877,7 +877,7 @@ public static BigDecimal minuteToDayPrecise(long num){
 
 	/**
 	 * 单位转换，秒转毫秒
-	 * @param num
+	 * @param num 待转换值
 	 * @return 毫秒数
 	 */
 	public static long secondToMillisecond(long num){
@@ -886,7 +886,7 @@ public static long secondToMillisecond(long num){
 
 	/**
 	 * 单位转换，秒转分钟
-	 * @param num
+	 * @param num 待转换值
 	 * @return 分钟数
 	 */
 	public static long secondToMinute(long num){
@@ -895,7 +895,7 @@ public static long secondToMinute(long num){
 
 	/**
 	 * 秒转分钟，精确计算，保留1位小数，ROUND_DOWN 舍去多余小数
-	 * @param num
+	 * @param num 待转换值
 	 * @return 分钟数，保留1位小数，ROUND_DOWN 舍去多余小数
 	 */
 	public static BigDecimal secondToMinutePrecise(long num){
@@ -904,7 +904,7 @@ public static BigDecimal secondToMinutePrecise(long num){
 
 	/**
 	 * 单位转换，秒转小时
-	 * @param num
+	 * @param num 待转换值
 	 * @return 小时数
 	 */
 	public static long secondToHour(long num){
@@ -913,7 +913,7 @@ public static long secondToHour(long num){
 
 	/**
 	 * 秒转小时，精确计算，保留1位小数，ROUND_DOWN 舍去多余小数
-	 * @param num
+	 * @param num 待转换值
 	 * @return 小时数，保留1位小数，ROUND_DOWN 舍去多余小数
 	 */
 	public static BigDecimal secondToHourPrecise(long num){
@@ -922,7 +922,7 @@ public static BigDecimal secondToHourPrecise(long num){
 
 	/**
 	 * 单位转换，秒转天
-	 * @param num
+	 * @param num 待转换值
 	 * @return 天数
 	 */
 	public static long secondToDay(long num){
@@ -931,7 +931,7 @@ public static long secondToDay(long num){
 
 	/**
 	 * 秒转天，精确计算，保留1位小数，ROUND_DOWN 舍去多余小数
-	 * @param num
+	 * @param num 待转换值
 	 * @return 天数，保留1位小数，ROUND_DOWN 舍去多余小数
 	 */
 	public static BigDecimal secondToDayPrecise(long num){
@@ -940,7 +940,7 @@ public static BigDecimal secondToDayPrecise(long num){
 
 	/**
 	 * 单位转换，毫秒转秒
-	 * @param num
+	 * @param num 待转换值
 	 * @return 秒数
 	 */
 	public static long millisecondToSecond(long num){
@@ -949,7 +949,7 @@ public static long millisecondToSecond(long num){
 
 	/**
 	 * 毫秒转秒，精确计算，保留1位小数，ROUND_DOWN 舍去多余小数
-	 * @param num
+	 * @param num 待转换值
 	 * @return 秒数，保留1位小数，ROUND_DOWN 舍去多余小数
 	 */	
 	public static BigDecimal millisecondToSecondPrecise(long num){
@@ -958,7 +958,7 @@ public static BigDecimal millisecondToSecondPrecise(long num){
 
 	/**
 	 * 毫秒转秒，精确计算，保留3位小数，ROUND_DOWN 舍去多余小数
-	 * @param num
+	 * @param num 待转换值
 	 * @return 秒数，保留3位小数，ROUND_DOWN 舍去多余小数
 	 */	
 	public static BigDecimal millisecondToSecondPreciseThree(long num){
@@ -967,7 +967,7 @@ public static BigDecimal millisecondToSecondPreciseThree(long num){
 
 	/**
 	 * 单位转换，毫秒转分钟
-	 * @param num
+	 * @param num 待转换值
 	 * @return 分钟数
 	 */
 	public static long millisecondToMinute(long num){
@@ -976,7 +976,7 @@ public static long millisecondToMinute(long num){
 
 	/**
 	 * 毫秒转分钟，精确计算，保留1位小数，ROUND_DOWN 舍去多余小数
-	 * @param num
+	 * @param num 待转换值
 	 * @return 分钟数，保留1位小数，ROUND_DOWN 舍去多余小数
 	 */	
 	public static BigDecimal millisecondToMinutePrecise(long num){
@@ -985,7 +985,7 @@ public static BigDecimal millisecondToMinutePrecise(long num){
 
 	/**
 	 * 单位转换，毫秒转小时
-	 * @param num
+	 * @param num 待转换值
 	 * @return 小时数
 	 */
 	public static long millisecondToHour(long num){
@@ -994,7 +994,7 @@ public static long millisecondToHour(long num){
 
 	/**
 	 * 毫秒转小时，精确计算，保留1位小数，ROUND_DOWN 舍去多余小数
-	 * @param num
+	 * @param num 待转换值
 	 * @return 小时数，保留1位小数，ROUND_DOWN 舍去多余小数
 	 */	
 	public static BigDecimal millisecondToHourPrecise(long num){
@@ -1003,7 +1003,7 @@ public static BigDecimal millisecondToHourPrecise(long num){
 
 	/**
 	 * 单位转换，毫秒转天
-	 * @param num
+	 * @param num 待转换值
 	 * @return 天数
 	 */
 	public static long millisecondToDay(long num){
@@ -1012,7 +1012,7 @@ public static long millisecondToDay(long num){
 
 	/**
 	 * 毫秒转天，精确计算，保留1位小数，ROUND_DOWN 舍去多余小数
-	 * @param num
+	 * @param num 待转换值
 	 * @return 天数，保留1位小数，ROUND_DOWN 舍去多余小数
 	 */	
 	public static BigDecimal millisecondToDayPrecise(long num){