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,
	}
}
