Skip to content

Commit 4597f46

Browse files
committed
修改说明文档
1 parent 7b02ffc commit 4597f46

File tree

3 files changed

+13
-11
lines changed

3 files changed

+13
-11
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,17 +27,17 @@ Generates Go classes from predefined objects, embedding assertion logic to preve
2727

2828
Extracts functions from existing code and generates Go packages, integrating assertion and crash handling.
2929

30-
### `cls_stub_gen`: **Generates Go Method Stubs with Assertions**
30+
### `cls_stub_gen`: **Generates Package-Level Function Wrappers**
3131

32-
Generates method stubs for Go objects, embedding assertions for proper error handling.
32+
Creates package-level functions that wrap methods of a singleton struct, simplifying access usage.
3333

3434
## Usage
3535

3636
### Examples:
3737

38-
- [sure_cls_gen](internal/examples/example_sure_cls_gen)
39-
- [sure_pkg_gen](internal/examples/example_sure_pkg_gen)
40-
- [cls_stub_gen](internal/examples/example_cls_stub_gen)
38+
- [Generating Classes with `sure_cls_gen`](internal/examples/example_sure_cls_gen)
39+
- [Generating Packages with `sure_pkg_gen`](internal/examples/example_sure_pkg_gen)
40+
- [Generating Singleton with `cls_stub_gen`](internal/examples/example_cls_stub_gen)
4141

4242
---
4343

README.zh.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,15 +22,15 @@
2222

2323
### `cls_stub_gen`: **生成带有断言的 Go 方法存根**
2424

25-
给 Go 对象生成方法存根,再嵌入断言以确保适当的错误处理
25+
给 Go 类型创建封装单例结构体方法的包级函数,简化访问使用。
2626

2727
## 使用示例
2828

2929
### 示例:
3030

31-
- [sure_cls_gen](internal/examples/example_sure_cls_gen)
32-
- [sure_pkg_gen](internal/examples/example_sure_pkg_gen)
33-
- [cls_stub_gen](internal/examples/example_cls_stub_gen)
31+
- [使用 `sure_cls_gen` 生成类](internal/examples/example_sure_cls_gen)
32+
- [使用 `sure_pkg_gen` 生成包](internal/examples/example_sure_pkg_gen)
33+
- [使用 `cls_stub_gen` 生成单例](internal/examples/example_cls_stub_gen)
3434

3535
---
3636

cls_stub_gen/stub_gen_test.go

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
package cls_stub_gen
22

33
import (
4+
"github.com/pkg/errors"
45
"testing"
56

67
"github.com/yyle88/runpath"
@@ -13,7 +14,8 @@ func (a *A) Get() *A {
1314
return a
1415
}
1516

16-
func (a *A) Set(string) {
17+
func (a *A) Set(string) error {
18+
return errors.New("not implement")
1719
}
1820

1921
func (a *A) Add(x int, y int) int {
@@ -33,7 +35,7 @@ func TestGenerateMethodsStub(t *testing.T) {
3335
OutputPath: "",
3436
AllowFileCreation: false,
3537
},
36-
NewStubParam(A{}, "a_a_a"),
38+
NewStubParam(A{}, "singletonInstance"),
3739
)
3840
t.Log(res)
3941
}

0 commit comments

Comments
 (0)