Skip to content

Commit 9ac9f0d

Browse files
moremindqicz
andauthored
[type:fix] update doc (#91)
* [type:fix] Update README.md * change to acmestack * [type:fix] Update README.md * [type:fix] Update README.md Co-authored-by: Qicz <qiczzhu@gmail.com>
1 parent 99d6542 commit 9ac9f0d

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,25 @@ func TestLog(t *testing.T) {
3333
}
3434
```
3535

36+
## Code Comment
37+
38+
### Code comment with method
39+
```go
40+
// TestLog test log
41+
// @params t tests params
42+
func TestLog(t *testing.T) {
43+
log.Info("test")
44+
}
45+
46+
// NewAsyncWriter Write data with Buffer, this Writer and Closer is thread safety, but WriteCloser parameters not safety.
47+
// @param w Writer
48+
// @param bufSize accept buffer max length
49+
// @param block if true, overflow buffer size, will blocking, if false will occur error
50+
// @return *AsyncLogWriter
51+
func NewAsyncWriter(w io.Writer, bufSize int, block bool) *AsyncLogWriter {
52+
}
53+
```
54+
3655
## Stargazers over time
3756

3857
[![Stargazers over time](https://starchart.cc/acmestack/godkits.svg)](https://starchart.cc/acmestack/godkits)

0 commit comments

Comments
 (0)