Skip to content

Commit 44fdda7

Browse files
committed
chore: improve comments for generated code
1 parent c0a0c9e commit 44fdda7

File tree

8 files changed

+71
-39
lines changed

8 files changed

+71
-39
lines changed

cmd/kod/internal/generate_generator.go

+2-1
Original file line numberDiff line numberDiff line change
@@ -774,7 +774,7 @@ func (g *generator) generateLocalStubs(p printFn) {
774774
p(`}`)
775775

776776
p(``)
777-
p(`// Check that %s implements the %s interface.`, stub, g.tset.genTypeString(comp.intf))
777+
p(`// Check that [%s] implements the [%s] interface.`, stub, g.tset.genTypeString(comp.intf))
778778
p(`var _ %s = (*%s)(nil)`, g.tset.genTypeString(comp.intf), stub)
779779
p(``)
780780

@@ -788,6 +788,7 @@ func (g *generator) generateLocalStubs(p printFn) {
788788
}
789789

790790
p(``)
791+
p(`// %s wraps the method [%s.%s].`, m.Name(), comp.implName(), m.Name())
791792
p(`func (s %s) %s(%s) (%s) {`, stub, m.Name(), g.args(mt), g.returns(mt))
792793

793794
// If the first argument is not context.Context, then we don't support interceptors.

examples/helloworld/kod_gen.go

+7-4
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

tests/case1/kod_gen.go

+30-15
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

tests/case2/kod_gen.go

+5-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

tests/case3/kod_gen.go

+7-4
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

tests/case4/kod_gen.go

+7-4
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

tests/case5/kod_gen.go

+2-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)