chore: improve comments for generated code

go-kod · Oct 22, 2024 · 44fdda7 · 44fdda7
1 parent c0a0c9e
commit 44fdda7
Show file tree

Hide file tree

Showing 8 changed files with 71 additions and 39 deletions.
diff --git a/cmd/kod/internal/generate_generator.go b/cmd/kod/internal/generate_generator.go
@@ -774,7 +774,7 @@ func (g *generator) generateLocalStubs(p printFn) {
 		p(`}`)
 
 		p(``)
-		p(`// Check that %s implements the %s interface.`, stub, g.tset.genTypeString(comp.intf))
+		p(`// Check that [%s] implements the [%s] interface.`, stub, g.tset.genTypeString(comp.intf))
 		p(`var _ %s = (*%s)(nil)`, g.tset.genTypeString(comp.intf), stub)
 		p(``)
 
@@ -788,6 +788,7 @@ func (g *generator) generateLocalStubs(p printFn) {
 			}
 
 			p(``)
+			p(`// %s wraps the method [%s.%s].`, m.Name(), comp.implName(), m.Name())
 			p(`func (s %s) %s(%s) (%s) {`, stub, m.Name(), g.args(mt), g.returns(mt))
 
 			// If the first argument is not context.Context, then we don't support interceptors.

diff --git a/examples/helloworld/kod_gen.go b/examples/helloworld/kod_gen.go
diff --git a/tests/case1/kod_gen.go b/tests/case1/kod_gen.go
diff --git a/tests/case2/kod_gen.go b/tests/case2/kod_gen.go
diff --git a/tests/case3/kod_gen.go b/tests/case3/kod_gen.go
diff --git a/tests/case4/kod_gen.go b/tests/case4/kod_gen.go
diff --git a/tests/case5/kod_gen.go b/tests/case5/kod_gen.go