feature: 自动化代码方法支持增加方法描述

Author: pixelmaxQm

server/model/system/request/sys_auto_code.go

@@ -236,6 +236,7 @@ type AutoFunc struct {
 	Package         string `json:"package"`
 	FuncName        string `json:"funcName"`        // 方法名称
 	Router          string `json:"router"`          // 路由名称
+	FuncDesc        string `json:"funcDesc"`        // 方法介绍
 	BusinessDB      string `json:"businessDB"`      // 业务库
 	StructName      string `json:"structName"`      // Struct名称
 	PackageName     string `json:"packageName"`     // 文件名称

server/resource/function/api.go.tpl

@@ -1,7 +1,7 @@
 {{if .IsPlugin}}
-// {{.FuncName}} 等待开发的的{{.Description}}接口
+// {{.FuncName}} {{.FuncDesc}}
 // @Tags {{.StructName}}
-// @Summary 等待开发的的{{.Description}}接口
+// @Summary {{.FuncDesc}}
 // @accept application/json
 // @Produce application/json
 // @Param data query request.{{.StructName}}Search true "分页获取{{.Description}}列表"
@@ -20,9 +20,9 @@ func (a *{{.Abbreviation}}) {{.FuncName}}(c *gin.Context) {
 
 {{- else -}}
 
-// {{.FuncName}} 等待开发的的{{.Description}}接口
+// {{.FuncName}} {{.FuncDesc}}
 // @Tags {{.StructName}}
-// @Summary 等待开发的的{{.Description}}接口
+// @Summary {{.FuncDesc}}
 // @accept application/json
 // @Produce application/json
 // @Param data query {{.Package}}Req.{{.StructName}}Search true "成功"

server/resource/function/api.js.tpl

@@ -1,7 +1,7 @@
 {{if .IsPlugin}}
-// {{.FuncName}} 等待开发的的{{.Description}}接口
+// {{.FuncName}} {{.FuncDesc}}
 // @Tags {{.StructName}}
-// @Summary 等待开发的的{{.Description}}接口
+// @Summary {{.FuncDesc}}
 // @accept application/json
 // @Produce application/json
 // @Param data query request.{{.StructName}}Search true "分页获取{{.Description}}列表"
@@ -16,9 +16,9 @@ export const {{.Router}} = () => {
 
 {{- else -}}
 
-// {{.FuncName}} 等待开发的的{{.Description}}接口
+// {{.FuncName}} {{.FuncDesc}}
 // @Tags {{.StructName}}
-// @Summary 等待开发的的{{.Description}}接口
+// @Summary {{.FuncDesc}}
 // @accept application/json
 // @Produce application/json
 // @Param data query {{.Package}}Req.{{.StructName}}Search true "成功"

server/resource/function/server.go.tpl

@@ -6,7 +6,7 @@
 {{- end}}
 {{if .IsPlugin}}
 
-// {{.FuncName}} 请实现方法
+// {{.FuncName}} {{.FuncDesc}}
 // Author [yourname](https://github.com/yourname)
 func (s *{{.Abbreviation}}) {{.FuncName}}() (err error) {
 	db := {{$db}}.Model(&model.{{.StructName}}{})
@@ -15,7 +15,7 @@ func (s *{{.Abbreviation}}) {{.FuncName}}() (err error) {
 
 {{- else -}}
 
-// {{.FuncName}} 请实现方法
+// {{.FuncName}} {{.FuncDesc}}
 // Author [yourname](https://github.com/yourname)
 func ({{.Abbreviation}}Service *{{.StructName}}Service){{.FuncName}}() (err error) {
 	// 请在这里实现自己的业务逻辑

web/src/view/systemTools/autoCodeAdmin/index.vue

@@ -177,6 +177,9 @@
           <el-form-item label="缩写：">
             <el-input v-model="autoFunc.abbreviation" placeholder="请输入缩写" disabled />
           </el-form-item>
+          <el-form-item label="方法名：">
+            <el-input v-model="autoFunc.funcDesc" placeholder="请输入方法介绍" />
+          </el-form-item>
           <el-form-item label="方法名：">
             <el-input v-model="autoFunc.funcName" placeholder="请输入方法名" />
           </el-form-item>
@@ -238,6 +241,7 @@ const autoFunc = ref({
   humpPackageName:"",
   businessDB:"",
   method:"",
+  funcDesc: ""
 })
 
 const addFuncBtn =  (row) => {
@@ -252,6 +256,7 @@ const addFuncBtn =  (row) => {
   autoFunc.value.method = ""
   autoFunc.value.funcName = ""
   autoFunc.value.router = ""
+  autoFunc.value.funcDesc = "方法介绍"
   funcFlag.value = true;
 };