Skip to content

Commit d21e532

Browse files
committed
refactor: Update comment
1 parent 18cc27a commit d21e532

File tree

4 files changed

+32
-24
lines changed

4 files changed

+32
-24
lines changed

README.cn.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -261,16 +261,8 @@ carbon.ParseByLayout("今天是 2020年08月05日13时14分15秒", "今天是 20
261261
carbon.ParseByLayout("2020-08-05 13:14:15", "2006-01-02 15:04:05", carbon.Tokyo).ToDateTimeString() // 2020-08-05 14:14:15
262262
```
263263

264-
##### 通过多个模糊的 `布局模板` 将时间字符串解析成 `Carbon` 实例
265-
266-
```go
267-
carbon.ParseByLayouts("2020|08|05 13|14|15", []string{"2006|01|02 15|04|05", "2006|1|2 3|4|5"}).ToDateTimeString() // 2020-08-05 13:14:15
268-
carbon.ParseByLayouts("2020|08|05 13|14|15", []string{"2006|01|02 15|04|05", "2006|1|2 3|4|5"}).CurrentLayout() // 2006|01|02 15|04|05
269-
```
270-
271264
##### 通过一个确认的 `格式模板` 将时间字符串解析成 `Carbon` 实例
272-
273-
> 如果使用的字母与格式模板冲突时,请使用转义符转义该字母
265+
> 注:如果使用的字母与格式模板冲突时,请使用转义符转义该字母
274266
275267
```go
276268
carbon.ParseByFormat("2020|08|05 13|14|15", "Y|m|d H|i|s").ToDateTimeString() // 2020-08-05 13:14:15
@@ -279,7 +271,16 @@ carbon.ParseByFormat("今天是 2020年08月05日13时14分15秒", "今天是 Y
279271
carbon.ParseByFormat("2020-08-05 13:14:15", "Y-m-d H:i:s", carbon.Tokyo).ToDateTimeString() // 2020-08-05 14:14:15
280272
```
281273

274+
##### 通过多个模糊的 `布局模板` 将时间字符串解析成 `Carbon` 实例
275+
> 注:该方法不支持通过时间戳 `布局模板` 解析
276+
277+
```go
278+
carbon.ParseByLayouts("2020|08|05 13|14|15", []string{"2006|01|02 15|04|05", "2006|1|2 3|4|5"}).ToDateTimeString() // 2020-08-05 13:14:15
279+
carbon.ParseByLayouts("2020|08|05 13|14|15", []string{"2006|01|02 15|04|05", "2006|1|2 3|4|5"}).CurrentLayout() // 2006|01|02 15|04|05
280+
```
281+
282282
##### 通过多个模糊的 `格式模板` 将时间字符串解析成 `Carbon` 实例
283+
> 注:该方法不支持通过时间戳 `格式模板` 解析
283284
284285
```go
285286
carbon.ParseByFormats("2020|08|05 13|14|15", []string{"Y|m|d H|i|s", "y|m|d h|i|s"}).ToDateTimeString() // 2020-08-05 13:14:15

README.jp.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -256,22 +256,26 @@ carbon.ParseByLayout("今天是 2020年08月05日13时14分15秒", "今天是 20
256256
carbon.ParseByLayout("2020-08-05 13:14:15", "2006-01-02 15:04:05", carbon.Tokyo).ToDateTimeString() // 2020-08-05 14:14:15
257257
```
258258

259-
##### 複数のファジィレイアウトテンプレートによって時間文字列を `Carbon` インスタンスに解析する
260-
261-
```go
262-
carbon.ParseWithLayouts("2020|08|05 13|14|15", []string{"2006|01|02 15|04|05", "2006|1|2 3|4|5"}).ToDateTimeString() // 2020-08-05 13:14:15
263-
carbon.ParseWithLayouts("2020|08|05 13|14|15", []string{"2006|01|02 15|04|05", "2006|1|2 3|4|5"}).CurrentLayout() // 2006|01|02 15|04|05
264-
```
265-
266259
##### 確認されたフォーマットテンプレートによって時間文字列を `Carbon` インスタンスに解析する
260+
> 注:使用する文字がフォームテンプレートと競合している場合は、エスケープを使用して文字をエスケープします
267261
268262
```go
269263
carbon.ParseByFormat("2020|08|05 13|14|15", "Y|m|d H|i|s").ToDateTimeString() // 2020-08-05 13:14:15
270264
carbon.ParseByFormat("It is 2020-08-05 13:14:15", "\\I\\t \\i\\s Y-m-d H:i:s").ToDateTimeString() // 2020-08-05 13:14:15
271265
carbon.ParseByFormat("今天是 2020年08月05日13时14分15秒", "今天是 Y年m月d日H时i分s秒").ToDateTimeString() // 2020-08-05 13:14:15
272266
```
273267

268+
##### 複数のファジィレイアウトテンプレートによって時間文字列を `Carbon` インスタンスに解析する
269+
> 注:タイムスタンプ `レイアウトテンプレート` による解析はサポートされていません
270+
271+
```go
272+
carbon.ParseWithLayouts("2020|08|05 13|14|15", []string{"2006|01|02 15|04|05", "2006|1|2 3|4|5"}).ToDateTimeString() // 2020-08-05 13:14:15
273+
carbon.ParseWithLayouts("2020|08|05 13|14|15", []string{"2006|01|02 15|04|05", "2006|1|2 3|4|5"}).CurrentLayout() // 2006|01|02 15|04|05
274+
```
275+
276+
274277
##### 複数のファジィフォーマットテンプレートによって時間文字列を `Carbon` インスタンスに解析する
278+
> 注:この方法では、タイムスタンプ `フォーマットテンプレート` による解析はサポートされていません
275279
276280
```go
277281
carbon.ParseByFormats("2020|08|05 13|14|15", []string{"Y|m|d H|i|s", "y|m|d h|i|s"}).ToDateTimeString() // 2020-08-05 13:14:15

README.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -255,22 +255,25 @@ carbon.ParseByLayout("It is 2020-08-05 13:14:15", "It is 2006-01-02 15:04:05").T
255255
carbon.ParseByLayout("今天是 2020年08月05日13时14分15秒", "今天是 2006年01月02日15时04分05秒").ToDateTimeString() // 2020-08-05 13:14:15
256256
```
257257

258-
##### Parse a time string as a `Carbon` instance by multiple fuzzy layouts
259-
260-
```go
261-
carbon.ParseByLayouts("2020|08|05 13|14|15", []string{"2006|01|02 15|04|05", "2006|1|2 3|4|5"}).ToDateTimeString() // 2020-08-05 13:14:15
262-
carbon.ParseByLayouts("2020|08|05 13|14|15", []string{"2006|01|02 15|04|05", "2006|1|2 3|4|5"}).CurrentLayout() // 2006|01|02 15|04|05
263-
```
264-
265258
##### Parse a time string as a `Carbon` instance by a confirmed format
259+
> Note: If the letter used conflicts with the format sign, please use an escape character to escape the letter
266260
267261
```go
268262
carbon.ParseByFormat("2020|08|05 13|14|15", "Y|m|d H|i|s").ToDateTimeString() // 2020-08-05 13:14:15
269263
carbon.ParseByFormat("It is 2020-08-05 13:14:15", "\\I\\t \\i\\s Y-m-d H:i:s").ToDateTimeString() // 2020-08-05 13:14:15
270264
carbon.ParseByFormat("今天是 2020年08月05日13时14分15秒", "今天是 Y年m月d日H时i分s秒").ToDateTimeString() // 2020-08-05 13:14:15
271265
```
272266

267+
##### Parse a time string as a `Carbon` instance by multiple fuzzy layouts
268+
> Note: it doesn't support parsing by timestamp layouts
269+
270+
```go
271+
carbon.ParseByLayouts("2020|08|05 13|14|15", []string{"2006|01|02 15|04|05", "2006|1|2 3|4|5"}).ToDateTimeString() // 2020-08-05 13:14:15
272+
carbon.ParseByLayouts("2020|08|05 13|14|15", []string{"2006|01|02 15|04|05", "2006|1|2 3|4|5"}).CurrentLayout() // 2006|01|02 15|04|05
273+
```
274+
273275
##### Parse a time string as a `Carbon` instance by multiple fuzzy formats
276+
> Note: it doesn't support parsing by timestamp formats
274277
275278
```go
276279
carbon.ParseByFormats("2020|08|05 13|14|15", []string{"Y|m|d H|i|s", "y|m|d h|i|s"}).ToDateTimeString() // 2020-08-05 13:14:15

type_carbon.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ func (c *Carbon) UnmarshalJSON(b []byte) error {
6363
return c.Error
6464
}
6565

66-
// String implements the interface Stringer for Carbon struct.
66+
// String implements Stringer interface for Carbon struct.
6767
func (c Carbon) String() string {
6868
if c.IsInvalid() || c.IsZero() {
6969
return ""

0 commit comments

Comments
 (0)