method comments

README.md

@@ -104,6 +104,7 @@ func NewQDReader(options ...QDReaderOption) *QDReader {
     return ret
 }
 
+// Read implements [io.Reader.Read].
 func (d *QDReader) Read(p []byte) (n int, err error) {
     return d.implRead(d.createContext("Read", d.implRead == nil), p)
 }
@@ -133,6 +134,7 @@ func (d *QDReader) createContext(methodName string, implIsNil bool) *QDReaderCon
 
 // Options
 
+// WithQDReaderRead implements [io.Reader.Read].
 func WithQDReaderRead(implRead func(qdCtx *QDReaderContext, p []byte) (n int, err error)) QDReaderOption {
     return func(d *QDReader) {
         d.implRead = implRead

cmd/qdiimpl/jenutil.go

@@ -103,3 +103,11 @@ func addTypeList(typeList *types.TypeList) func(*jen.Group) {
 		}
 	}
 }
+
+func formatObjetName(obj types.Object) string {
+	pkg := ""
+	if obj.Pkg().Path() != "" {
+		pkg += obj.Pkg().Path()
+	}
+	return pkg + "." + obj.Name()
+}

cmd/qdiimpl/qdiimpl.go

@@ -253,6 +253,7 @@ func gen(outputName string, obj types.Object, iface *types.Interface) error {
 		sig := mtd.Type().(*types.Signature)
 
 		// # func (d *debugTYPE) METHOD(METHODPARAMS...) (METHODRESULTS...) {}
+		f.Commentf("%s implements [%s.%s].", mtd.Name(), formatObjetName(obj), mtd.Name())
 		f.Func().Params(Id("d").Op("*").Id(objName).TypesFunc(codeObjectTypes)).Id(mtd.Name()).ParamsFunc(func(pgroup *Group) {
 			for k := 0; k < sig.Params().Len(); k++ {
 				sigParam := sig.Params().At(k)
@@ -388,6 +389,7 @@ func gen(outputName string, obj types.Object, iface *types.Interface) error {
 		f.Line()
 
 		// # func WithQDTYPEMETHOD(implMETHOD func(qdCtx *QDTYPEContext, METHODPARAMS...) (METHODRESULTS...)) QDTYPEOption {}
+		f.Commentf("With%s%s implements [%s.%s].", objName, mtd.Name(), formatObjetName(obj), mtd.Name())
 		f.Func().Id("With" + objName + mtd.Name()).TypesFunc(codeObjectTypesWithType).Params(
 			Id("impl" + mtd.Name()).Func().ParamsFunc(func(pgroup *Group) {
 				// add debug context parameter