可以给生成的结构添加注释

Author: alex cai

README.md

@@ -30,7 +30,6 @@ go-db-models
 `*_tb_gen.go`文件样例如下：
 
 ```go
-
 // DON'T EDIT *** generated by go-db-models *** DON'T EDIT //
 package test
 
@@ -128,8 +127,10 @@ func AdProjectQuery(db *sql.DB, queryString string) (ad_project []*AdProjectTabl
             "name": "ad_plan",
             // 需要生成的字段
             "fields": ["id", "name", "status", "daily_budget", "start_date", "created_at"],
-            // 这是可选项，如果定义了该字段，则会自动生成一个类似QueryById的查询函数。
-            "queryBy": "id"
+            // [可选]这是可选项，如果定义了该字段，则会自动生成一个类似QueryById的查询函数。
+            "queryBy": "id",
+            // [可选]结构体增加注释
+            "msg": "这是注释。。。"
         },
         {
             "name": "ad_project",

models/json.go

@@ -15,6 +15,7 @@ type JsonTableConf struct {
 	Name    string   // 表名
 	Fields  []string // 字段名
 	QueryBy string   // QueryBy函数定义
+	Msg     string   // 表结构说明
 }
 
 // 将json文件decode成结构体

models/parse_table.go

@@ -18,9 +18,9 @@ type ParseTable struct {
 	PrimaryType  string   // 主键的类型，如：uint32, sql.NullString等
 	Imports      []string // 需要import的包
 	SelectFields string   // sql查询中的select fields
+	Msg          string   // 表结构的说明
 	Fields       []ParseField
-
-	QueryBy QueryBy // QueryBy函数，例如QueryById等
+	QueryBy      QueryBy // QueryBy函数，例如QueryById等
 }
 
 // 字段的定义
@@ -46,6 +46,7 @@ func ParseTablesStruct(tables []Table, packageName string, modelsConf *JsonConf)
 	// 配置的预处理
 	var modelsConfMap = map[string]map[string]bool{} // 第一个下标是表名，第二个下标是字段名
 	var queryByConf = map[string]string{}            // 下标是表名，值是字段名，例如id。
+	var tableConfMsg = map[string]string{}           // 表的注释（在json文件中的）
 	if len(modelsConf.Tables) > 0 {
 		for _, tb := range modelsConf.Tables {
 			modelsConfMap[tb.Name] = map[string]bool{}
@@ -56,6 +57,8 @@ func ParseTablesStruct(tables []Table, packageName string, modelsConf *JsonConf)
 			if tb.QueryBy != "" {
 				queryByConf[tb.Name] = tb.QueryBy
 			}
+
+			tableConfMsg[tb.Name] = tb.Msg
 		}
 	}
 
@@ -66,6 +69,7 @@ func ParseTablesStruct(tables []Table, packageName string, modelsConf *JsonConf)
 
 		ptable := ParseTable{
 			Name:        table.Name,
+			Msg:         tableConfMsg[table.Name],
 			PackageName: packageName,
 		}
 		ptable.Fields, ptable.Imports, ptable.PrimaryType = ParseFieldsStruct(table.Fields, modelsConfMap[table.Name])

models/template.go

@@ -11,7 +11,8 @@ import "{{$v}}"{{end}}
 import "strings"
 import "database/sql"
 
-// 对应数据表：{{.Name}}
+// 对应数据表：{{.Name}}{{if .Msg}}
+// {{.Msg}}{{end}}
 type {{.Name|Format2StructName}}Table struct { 
 {{range $k, $v := .Fields}}
 {{$v.Name|Format2StructName}}  {{$v.Type}} {{$v.Name|Format2StructTag}}{{end}}