modified 增加结构体描述，完善自动化文档

2021-04-30 14:14:00 +08:00
parent f9296d90d4
commit 3e85645e44
31 changed files with 881 additions and 388 deletions
@@ -1,11 +1,11 @@
 package config

 type Email struct {
-	To       string `mapstructure:"to" json:"to" yaml:"to"`
-	Port     int    `mapstructure:"port" json:"port" yaml:"port"`
-	From     string `mapstructure:"from" json:"from" yaml:"from"`
-	Host     string `mapstructure:"host" json:"host" yaml:"host"`
-	IsSSL    bool   `mapstructure:"is-ssl" json:"isSSL" yaml:"is-ssl"`
-	Secret   string `mapstructure:"secret" json:"secret" yaml:"secret"`
-	Nickname string `mapstructure:"nickname" json:"nickname" yaml:"nickname"`
+	To       string `mapstructure:"to" json:"to" yaml:"to"`                   // 收件人
+	Port     int    `mapstructure:"port" json:"port" yaml:"port"`             // 端口
+	From     string `mapstructure:"from" json:"from" yaml:"from"`             // 收件人
+	Host     string `mapstructure:"host" json:"host" yaml:"host"`             // 服务器地址
+	IsSSL    bool   `mapstructure:"is-ssl" json:"isSSL" yaml:"is-ssl"`        // 是否SSL
+	Secret   string `mapstructure:"secret" json:"secret" yaml:"secret"`       // 密钥
+	Nickname string `mapstructure:"nickname" json:"nickname" yaml:"nickname"` // 昵称
 }