Skip to content

Commit 676ad0e

Browse files
committed
docs(Time): 更新注释以明确使用当前时区而非本地时间
更新 TimerHelper.Week.cs 中的 XML 文档注释,将“本地时间(DateTime.Now)”的表述统一替换为“当前时区 (<see cref="CurrentTimeZone"/>) 时间”。这更准确地反映了代码实际使用的时区来源,避免了“本地时间”可能引起的歧义。
1 parent 2bdf1f8 commit 676ad0e

1 file changed

Lines changed: 9 additions & 9 deletions

File tree

GameFrameX.Foundation.Utility/Time/TimerHelper.Week.cs

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -50,13 +50,13 @@ public static bool IsNowSameWeek(long ticks)
5050
/// <summary>
5151
/// 判断当前时间是否与指定时间处于同一周。
5252
/// 以周一为每周的第一天,周日为每周的最后一天。
53-
/// 使用本地时间(DateTime.Now)进行比较
53+
/// 使用当前时区 (<see cref="CurrentTimeZone"/>) 时间进行比较
5454
/// </summary>
5555
/// <param name="start">指定时间的起始时间。可以是任意DateTime值。</param>
5656
/// <returns>如果当前时间与指定时间处于同一周,则为 true;否则为 false。</returns>
5757
/// <remarks>
5858
/// 此方法将调用IsSameWeek方法进行实际比较。
59-
/// 使用本地时区时间作为当前时间参考点
59+
/// 使用当前时区 (<see cref="CurrentTimeZone"/>) 时间作为当前时间参考点
6060
/// </remarks>
6161
public static bool IsNowSameWeek(DateTime start)
6262
{
@@ -191,7 +191,7 @@ public static DateTime GetDayOfWeekTime(DateTime dateTime, DayOfWeek day)
191191
/// <returns>返回当前UTC日期所在星期的指定星期几的零点时间。例如:当前是2024-01-10(星期三),传入DayOfWeek.Monday,则返回2024-01-08 00:00:00。</returns>
192192
/// <remarks>
193193
/// 此方法使用UTC时间作为基准计算。
194-
/// 如果需要使用本地时间,请使用 GetDayOfWeekTime(DateTime.Now, day)。
194+
/// 如果需要使用当前时区 (<see cref="CurrentTimeZone"/>) 时间,请使用 GetDayOfWeekTime(GetNow(), day)。
195195
/// </remarks>
196196
public static DateTime GetDayOfWeekTime(DayOfWeek day)
197197
{
@@ -226,8 +226,8 @@ public static int GetChinaDayOfWeek(DayOfWeek day)
226226
/// </summary>
227227
/// <returns>当前星期在中国的对应数字。返回1-7,其中7表示星期日</returns>
228228
/// <remarks>
229-
/// 此方法获取当前本地时间的星期几,并转换为中国习惯的表示方式
230-
/// 使用本地时区时间(DateTime.Now)作为基准
229+
/// 此方法获取当前时区 (<see cref="CurrentTimeZone"/>) 时间的星期几,并转换为中国习惯的表示方式
230+
/// 使用当前时区 (<see cref="CurrentTimeZone"/>) 时间作为基准
231231
/// 内部调用GetChinaDayOfWeek(DayOfWeek)方法进行转换
232232
/// </remarks>
233233
public static int GetChinaDayOfWeek()
@@ -244,7 +244,7 @@ public static int GetChinaDayOfWeek()
244244
/// 使用中国习惯:
245245
/// - 将周日的DayOfWeek值0转换为7
246246
/// - 以周一为每周的第一天
247-
/// 返回的是本地时区的时间
247+
/// 返回的是当前时区 (<see cref="CurrentTimeZone"/>) 的时间
248248
/// </remarks>
249249
public static DateTime GetWeekStartTime()
250250
{
@@ -276,7 +276,7 @@ public static long GetWeekStartTimestamp()
276276
/// <remarks>
277277
/// 此方法返回本周日的最后一秒(23:59:59)
278278
/// 通过获取下周一零点时间然后减去1秒来计算
279-
/// 返回的是本地时区的时间
279+
/// 返回的是当前时区 (<see cref="CurrentTimeZone"/>) 的时间
280280
/// </remarks>
281281
public static DateTime GetWeekEndTime()
282282
{
@@ -341,7 +341,7 @@ public static long GetStartTimestampOfWeek(DateTime date)
341341
/// <remarks>
342342
/// 此方法返回下周一的零点时间
343343
/// 例如:当前是2024-01-10(周三),返回2024-01-15 00:00:00(下周一)
344-
/// 使用本地时区计算时间
344+
/// 使用当前时区 (<see cref="CurrentTimeZone"/>) 计算时间
345345
/// </remarks>
346346
public static DateTime GetNextWeekStartTime()
347347
{
@@ -370,7 +370,7 @@ public static long GetNextWeekStartTimestamp()
370370
/// <remarks>
371371
/// 此方法返回下周日的最后一秒
372372
/// 例如:当前是2024-01-10(周三),返回2024-01-21 23:59:59(下周日)
373-
/// 使用本地时区计算时间
373+
/// 使用当前时区 (<see cref="CurrentTimeZone"/>) 计算时间
374374
/// </remarks>
375375
public static DateTime GetNextWeekEndTime()
376376
{

0 commit comments

Comments
 (0)