Code optimized (#523)

* optimized markdown generator

* optimized markdown generator

* optimized markdown generator

* add more comment

* add comment

* add comment

* add comments for rpc tool

* add comments for model tool

* add comments for model tool

* add comments for model tool

* add comments for config tool

* add comments for config tool

* add comments

* add comments

* add comments

* add comments

* add comment

* remove rpc main head info

* add comment

* optimized

Co-authored-by: anqiansong <anqiansong@xiaoheiban.cn>

tools/goctl/rpc/generator/gen.go

@@ -10,27 +10,33 @@ import (
 	"github.com/tal-tech/go-zero/tools/goctl/util/ctx"
 )
 
-type RpcGenerator struct {
+// RPCGenerator defines a generator and configure
+type RPCGenerator struct {
 	g   Generator
 	cfg *conf.Config
 }
 
-func NewDefaultRpcGenerator(style string) (*RpcGenerator, error) {
+// NewDefaultRPCGenerator wraps Generator with configure
+func NewDefaultRPCGenerator(style string) (*RPCGenerator, error) {
 	cfg, err := conf.NewConfig(style)
 	if err != nil {
 		return nil, err
 	}
-	return NewRpcGenerator(NewDefaultGenerator(), cfg), nil
+	return NewRPCGenerator(NewDefaultGenerator(), cfg), nil
 }
 
-func NewRpcGenerator(g Generator, cfg *conf.Config) *RpcGenerator {
-	return &RpcGenerator{
+// NewRPCGenerator creates an instance for RPCGenerator
+func NewRPCGenerator(g Generator, cfg *conf.Config) *RPCGenerator {
+	return &RPCGenerator{
 		g:   g,
 		cfg: cfg,
 	}
 }
 
-func (g *RpcGenerator) Generate(src, target string, protoImportPath []string) error {
+// Generate generates an rpc service, through the proto file,
+// code storage directory, and proto import parameters to control
+// the source file and target location of the rpc service that needs to be generated
+func (g *RPCGenerator) Generate(src, target string, protoImportPath []string) error {
 	abs, err := filepath.Abs(target)
 	if err != nil {
 		return err