初始化项目

trunk/center/common/remark/methodRemark.go

@@ -0,0 +1,58 @@
+package remark
+
+// 方法说明对象
+type MethodRemark struct {
+	// 模块名称
+	ModuleName string
+
+	// 方法名称
+	Name string
+
+	// 方法描述
+	Desc string
+
+	// 接口作者
+	Author string
+
+	// 修改者
+	Mendor string
+
+	// 接口设计日期
+	Date string
+
+	// 输入参数
+	InParam []string
+
+	// 输出参数
+	OutParam string
+}
+
+// newMethodRemark
+// 	@description: 创建新的方法说明对象
+// parameter:
+//	@moduleName: 模块名称
+//	@name: 方法名称
+//	@desc: 方法描述
+//	@author: 方法作者
+//	@mendor: 方法修改者（多个用，分隔）
+//	@date: 创建日期
+//	@inParam: 输入参数
+//	@outParam: 输出参数
+// return:
+//	@*MethodRemark: 新的方法说明对象
+func newMethodRemark(moduleName, name, desc, author, mendor, date string, inParam []string, outParam string) *MethodRemark {
+	if mendor == "" {
+		mendor = "无"
+	}
+
+	return &MethodRemark{
+		ModuleName: moduleName,
+		Name:       name,
+		Desc:       desc,
+		Author:     author,
+		Mendor:     mendor,
+		Date:       date,
+		InParam:    inParam,
+		OutParam:   outParam,
+	}
+}

trunk/center/common/remark/moduleRemark.go

@@ -0,0 +1,48 @@
+package remark
+
+// ModuleRemark
+//	 @description: 模块说明对象
+type ModuleRemark struct {
+	// 模块名称
+	Name string
+
+	// 模块描述
+	Desc string
+
+	// 接口作者
+	Author string
+
+	// 修改者
+	Mendor string
+
+	// 接口设计日期
+	Date string
+
+	// 方法对象列表
+	MethodRemarkSlice []*MethodRemark
+}
+
+// newModuleRemark
+// 	@description: 创建新的模块说明对象
+// parameter:
+//	@name: 模块名称
+//	@desc: 模块描述
+//	@author: 模块作者
+//	@mendor: 模块修改者（多个用，分隔）
+//	@date: 创建日期
+// return:
+//	@*ModuleRemark: 新的模块说明对象
+func newModuleRemark(name, desc, author, mendor, date string) *ModuleRemark {
+	if mendor == "" {
+		mendor = "无"
+	}
+
+	return &ModuleRemark{
+		Name:              name,
+		Desc:              desc,
+		Author:            author,
+		Mendor:            mendor,
+		Date:              date,
+		MethodRemarkSlice: make([]*MethodRemark, 0, 16),
+	}
+}

trunk/center/common/remark/remarkMgr.go

@@ -0,0 +1,60 @@
+package remark
+
+import (
+	"goutil/logUtilPlus"
+)
+
+var (
+	remarksSlice []*ModuleRemark = make([]*ModuleRemark, 0, 32)
+)
+
+// RegisterModuleRemark
+//
+//	@description: 注册模块说明对象
+//
+// parameter:
+//
+//	@name: 模块名称
+//	@desc: 模块描述
+//	@author: 模块作者
+//	@mendor: 模块修改者（多个用，分隔）
+//	@date: 创建日期
+//
+// return:
+func RegisterModuleRemark(name, desc, author, mendor, date string) {
+	remarksSlice = append(remarksSlice, newModuleRemark(name, desc, author, mendor, date))
+}
+
+// RegisterMethodRemark
+//
+//	@description: 注册方法说明对象
+//
+// parameter:
+//
+//	@moduleName: 模块名称
+//	@name: 方法名称
+//	@desc: 方法描述
+//	@author: 方法作者
+//	@mendor: 方法修改者（多个用，分隔）
+//	@date: 创建日期
+//	@inParam: 输入参数
+//	@outParam: 输出参数
+//
+// return:
+func RegisterMethodRemark(moduleName, name, desc, author, mendor, date string, inParam []string, outParam string) {
+	var moduleRemark *ModuleRemark
+	var exists bool
+	for _, item := range remarksSlice {
+		if item.Name == moduleName {
+			moduleRemark = item
+			exists = true
+		}
+	}
+
+	if !exists {
+		logUtilPlus.ErrorLog("ModuleRemark:%s尚未注册", moduleName)
+		return
+	}
+
+	moduleRemark.MethodRemarkSlice = append(moduleRemark.MethodRemarkSlice, newMethodRemark(moduleName, name, desc, author, mendor, date, inParam, outParam))
+}

trunk/center/common/remark/webApi.go

@@ -0,0 +1,56 @@
+package remark
+
+import (
+	"common/httpServer"
+	"fmt"
+	"net/http"
+
+	"common/webServer"
+)
+
+// init
+// @description: init
+// parameter:
+// return:
+func init() {
+	webServer.RegisterRemarkFunc(remarkdCallback)
+	httpServer.RegisterRemarkFunc(remarkdCallback)
+}
+
+// remarkdCallback
+// @description: remarkdCallback
+// parameter:
+// @w: w
+// @r: r
+// return:
+func remarkdCallback(w http.ResponseWriter, r *http.Request) {
+
+	for index, moduleItem := range remarksSlice {
+		// 输出模块信息
+		fmt.Fprintf(w, fmt.Sprintf("%d、%s【Name:%s  Author:%s  Mendor:%s  Date:%s】\n", index+1, moduleItem.Desc, moduleItem.Name, moduleItem.Author, moduleItem.Mendor, moduleItem.Date))
+
+		// 输出方法列表信息
+		for subIndex, methodItem := range moduleItem.MethodRemarkSlice {
+			fmt.Fprintf(w, fmt.Sprintf("  %d.%d、%s【Name:%s  Author:%s  Mendor:%s  Date:%s】\n", index+1, subIndex+1, methodItem.Desc, methodItem.Name, methodItem.Author, methodItem.Mendor, methodItem.Date))
+
+			fmt.Fprintln(w, "  \t输入参数：")
+			if len(methodItem.InParam) > 0 {
+				for _, param := range methodItem.InParam {
+					fmt.Fprintln(w, "    ", param)
+				}
+			} else {
+				fmt.Fprintln(w, "    ", "无")
+			}
+
+			fmt.Fprintln(w, "  \t输出参数：")
+			if methodItem.OutParam != "" {
+				fmt.Fprintln(w, "    ", methodItem.OutParam)
+			} else {
+				fmt.Fprintln(w, "    ", "无")
+			}
+
+			fmt.Fprintln(w)
+		}
+	}
+	return
+}