improve comment ,参考：https://github.com/huacnlee/autocorrect

2026-02-06 13:42:26 +08:00 · 2024-07-19 12:04:04 +08:00
parent ba0a1477eb
commit d8fde54f2d
118 changed files with 974 additions and 867 deletions
--- a/miniprogram/analysis/analysis.go
+++ b/miniprogram/analysis/analysis.go
@@ -56,8 +56,8 @@ func (analysis *Analysis) fetchData(urlStr string, body interface{}) (response [

 // RetainItem 留存项结构
 type RetainItem struct {
-	Key   int `json:"key"`   // 标识，0开始表示当天，1表示1甜后，以此类推
-	Value int `json:"value"` // key对应日期的新增用户数/活跃用户数（key=0时）或留存用户数（k>0时）
+	Key   int `json:"key"`   // 标识，0 开始表示当天，1 表示 1 甜后，以此类推
+	Value int `json:"value"` // key 对应日期的新增用户数/活跃用户数（key=0 时）或留存用户数（k>0 时）
 }

 // ResAnalysisRetain 小程序留存数据返回
@@ -68,7 +68,7 @@ type ResAnalysisRetain struct {
 	VisitUV    []RetainItem `json:"visit_uv"`     // 活跃用户留存
 }

-// getAnalysisRetain 获取用户访问小程序留存数据(日、月、周)
+// getAnalysisRetain 获取用户访问小程序留存数据 (日、月、周)
 func (analysis *Analysis) getAnalysisRetain(urlStr string, beginDate, endDate string) (result ResAnalysisRetain, err error) {
 	body := map[string]string{
 		"begin_date": beginDate,
@@ -137,7 +137,7 @@ func (analysis *Analysis) GetAnalysisDailySummary(beginDate, endDate string) (re
 	return
 }

-// ResAnalysisVisitTrend 小程序访问数据趋势(日、月、周)
+// ResAnalysisVisitTrend 小程序访问数据趋势 (日、月、周)
 type ResAnalysisVisitTrend struct {
 	util.CommonError
 	List []struct {
@@ -152,7 +152,7 @@ type ResAnalysisVisitTrend struct {
 	} `json:"list"`
 }

-// getAnalysisRetain 获取小程序访问数据趋势(日、月、周)
+// getAnalysisRetain 获取小程序访问数据趋势 (日、月、周)
 func (analysis *Analysis) getAnalysisVisitTrend(urlStr string, beginDate, endDate string) (result ResAnalysisVisitTrend, err error) {
 	body := map[string]string{
 		"begin_date": beginDate,
@@ -190,9 +190,9 @@ func (analysis *Analysis) GetAnalysisWeeklyVisitTrend(beginDate, endDate string)

 // UserPortraitItem 用户画像项目
 type UserPortraitItem struct {
-	ID    int    `json:"id"`    // 属性值id
+	ID    int    `json:"id"`    // 属性值 id
 	Name  string `json:"name"`  // 属性值名称
-	Value int    `json:"value"` // 该场景访问uv
+	Value int    `json:"value"` // 该场景访问 uv
 }

 // UserPortrait 用户画像
@@ -201,9 +201,9 @@ type UserPortrait struct {
 	Province  []UserPortraitItem `json:"province"`  // 省份，如北京、广东等
 	City      []UserPortraitItem `json:"city"`      // 城市，如北京、广州等
 	Genders   []UserPortraitItem `json:"genders"`   // 性别，包括男、女、未知
-	Platforms []UserPortraitItem `json:"platforms"` // 终端类型，包括iPhone, android, 其他
-	Devices   []UserPortraitItem `json:"devices"`   // 机型，如苹果iPhone 6, OPPO R9等
-	Ages      []UserPortraitItem `json:"ages"`      // 年龄，包括17岁以下、18-24对等区间
+	Platforms []UserPortraitItem `json:"platforms"` // 终端类型，包括 iPhone, android, 其他
+	Devices   []UserPortraitItem `json:"devices"`   // 机型，如苹果 iPhone 6, OPPO R9 等
+	Ages      []UserPortraitItem `json:"ages"`      // 年龄，包括 17 岁以下、18-24 对等区间
 }

 // ResAnalysisUserPortrait 小程序新增或活跃用户的画像分布数据返回
@@ -237,9 +237,9 @@ func (analysis *Analysis) GetAnalysisUserPortrait(beginDate, endDate string) (re

 // VisitDistributionIndexItem 访问分数数据结构
 type VisitDistributionIndexItem struct {
-	Key                 int `json:"key"`                    // 场景id
-	Value               int `json:"value"`                  // 该场景id访问pv
-	AccessSourceVisitUV int `json:"access_source_visit_uv"` // 该场景id访问uv
+	Key                 int `json:"key"`                    // 场景 id
+	Value               int `json:"value"`                  // 该场景 id 访问 pv
+	AccessSourceVisitUV int `json:"access_source_visit_uv"` // 该场景 id 访问 uv
 }

 // VisitDistributionIndex 访问分布单分布类型数据
--- a/miniprogram/auth/auth.go
+++ b/miniprogram/auth/auth.go
@@ -33,7 +33,7 @@ type ResCode2Session struct {

 	OpenID     string `json:"openid"`      // 用户唯一标识
 	SessionKey string `json:"session_key"` // 会话密钥
-	UnionID    string `json:"unionid"`     // 用户在开放平台的唯一标识符，在满足UnionID下发条件的情况下会返回
+	UnionID    string `json:"unionid"`     // 用户在开放平台的唯一标识符，在满足 UnionID 下发条件的情况下会返回
 }

 // RspCheckEncryptedData .
@@ -70,12 +70,12 @@ func (auth *Auth) GetPaidUnionID() {
 	// TODO
 }

-// CheckEncryptedData .检查加密信息是否由微信生成（当前只支持手机号加密数据），只能检测最近3天生成的加密数据
+// CheckEncryptedData .检查加密信息是否由微信生成（当前只支持手机号加密数据），只能检测最近 3 天生成的加密数据
 func (auth *Auth) CheckEncryptedData(encryptedMsgHash string) (result RspCheckEncryptedData, err error) {
 	return auth.CheckEncryptedDataContext(context2.Background(), encryptedMsgHash)
 }

-// CheckEncryptedDataContext .检查加密信息是否由微信生成（当前只支持手机号加密数据），只能检测最近3天生成的加密数据
+// CheckEncryptedDataContext .检查加密信息是否由微信生成（当前只支持手机号加密数据），只能检测最近 3 天生成的加密数据
 func (auth *Auth) CheckEncryptedDataContext(ctx context2.Context, encryptedMsgHash string) (result RspCheckEncryptedData, err error) {
 	var response []byte
 	var (
@@ -85,7 +85,7 @@ func (auth *Auth) CheckEncryptedDataContext(ctx context2.Context, encryptedMsgHa
 		return
 	}

-	// 由于GetPhoneNumberContext需要传入JSON，所以HTTPPostContext入参改为[]byte
+	// 由于 GetPhoneNumberContext 需要传入 JSON，所以 HTTPPostContext 入参改为 []byte
 	if response, err = util.HTTPPostContext(ctx, fmt.Sprintf(checkEncryptedDataURL, at), []byte("encrypted_msg_hash="+encryptedMsgHash), nil); err != nil {
 		return
 	}
@@ -113,7 +113,7 @@ type PhoneInfo struct {
 	} `json:"watermark"` // 数据水印
 }

-// GetPhoneNumberContext 小程序通过code获取用户手机号
+// GetPhoneNumberContext 小程序通过 code 获取用户手机号
 func (auth *Auth) GetPhoneNumberContext(ctx context2.Context, code string) (*GetPhoneNumberResponse, error) {
 	var response []byte
 	var (
@@ -142,7 +142,7 @@ func (auth *Auth) GetPhoneNumberContext(ctx context2.Context, code string) (*Get
 	return &result, err
 }

-// GetPhoneNumber 小程序通过code获取用户手机号
+// GetPhoneNumber 小程序通过 code 获取用户手机号
 func (auth *Auth) GetPhoneNumber(code string) (*GetPhoneNumberResponse, error) {
 	return auth.GetPhoneNumberContext(context2.Background(), code)
 }
--- a/miniprogram/business/phone_number.go
+++ b/miniprogram/business/phone_number.go
@@ -21,12 +21,12 @@ type PhoneInfo struct {
 	PurePhoneNumber string `json:"purePhoneNumber"` // 没有区号的手机号
 	CountryCode     string `json:"countryCode"`     // 区号
 	Watermark       struct {
-		AppID     string `json:"appid"`     // 小程序appid
+		AppID     string `json:"appid"`     // 小程序 appid
 		Timestamp int64  `json:"timestamp"` // 用户获取手机号操作的时间戳
 	} `json:"watermark"`
 }

-// GetPhoneNumber code换取用户手机号。 每个code只能使用一次，code的有效期为5min
+// GetPhoneNumber code 换取用户手机号。每个 code 只能使用一次，code 的有效期为 5min
 func (business *Business) GetPhoneNumber(in *GetPhoneNumberRequest) (info PhoneInfo, err error) {
 	accessToken, err := business.GetAccessToken()
 	if err != nil {
--- a/miniprogram/content/content.go
+++ b/miniprogram/content/content.go
@@ -44,7 +44,7 @@ func (content *Content) CheckText(text string) error {
 }

 // CheckImage 检测图片
-// 所传参数为要检测的图片文件的绝对路径，图片格式支持PNG、JPEG、JPG、GIF, 像素不超过 750 x 1334，同时文件大小以不超过 300K 为宜，否则可能报错
+// 所传参数为要检测的图片文件的绝对路径，图片格式支持 PNG、JPEG、JPG、GIF, 像素不超过 750 x 1334，同时文件大小以不超过 300K 为宜，否则可能报错
 // @media 图片文件的绝对路径
 // Deprecated
 // 采用 security.ImageCheckV1 替代，返回值更加丰富
--- a/miniprogram/encryptor/encryptor.go
+++ b/miniprogram/encryptor/encryptor.go
@@ -24,13 +24,13 @@ func NewEncryptor(context *context.Context) *Encryptor {
 }

 var (
-	// ErrAppIDNotMatch appid不匹配
+	// ErrAppIDNotMatch appid 不匹配
 	ErrAppIDNotMatch = errors.New("app id not match")
-	// ErrInvalidBlockSize block size不合法
+	// ErrInvalidBlockSize block size 不合法
 	ErrInvalidBlockSize = errors.New("invalid block size")
-	// ErrInvalidPKCS7Data PKCS7数据不合法
+	// ErrInvalidPKCS7Data PKCS7 数据不合法
 	ErrInvalidPKCS7Data = errors.New("invalid PKCS7 data")
-	// ErrInvalidPKCS7Padding 输入padding失败
+	// ErrInvalidPKCS7Padding 输入 padding 失败
 	ErrInvalidPKCS7Padding = errors.New("invalid padding on input")
 )

--- a/miniprogram/message/updatable_msg.go
+++ b/miniprogram/message/updatable_msg.go
@@ -8,7 +8,7 @@ import (
 )

 const (
-	// createActivityURL 创建activity_id
+	// createActivityURL 创建 activity_id
 	createActivityURL = "https://api.weixin.qq.com/cgi-bin/message/wxopen/activityid/create?access_token=%s"
 	// SendUpdatableMsgURL 修改动态消息
 	setUpdatableMsgURL = "https://api.weixin.qq.com/cgi-bin/message/wxopen/updatablemsg/send?access_token=%s"
@@ -38,7 +38,7 @@ func NewUpdatableMessage(ctx *context.Context) *UpdatableMessage {
 	}
 }

-// CreateActivityID 创建activity_id
+// CreateActivityID 创建 activity_id
 func (updatableMessage *UpdatableMessage) CreateActivityID() (res CreateActivityIDResponse, err error) {
 	accessToken, err := updatableMessage.GetAccessToken()
 	if err != nil {
@@ -75,7 +75,7 @@ func (updatableMessage *UpdatableMessage) SetUpdatableMsg(activityID string, tar
 	return util.DecodeWithCommonError(response, "SendUpdatableMsg")
 }

-// CreateActivityIDResponse 创建activity_id 返回
+// CreateActivityIDResponse 创建 activity_id 返回
 type CreateActivityIDResponse struct {
 	util.CommonError

--- a/miniprogram/order/shipping.go
+++ b/miniprogram/order/shipping.go
@@ -114,29 +114,29 @@ type UploadShippingInfoRequest struct {

 // ShippingOrderKey 订单
 type ShippingOrderKey struct {
-	OrderNumberType NumberType `json:"order_number_type"` // 订单单号类型，用于确认需要上传详情的订单。枚举值1，使用下单商户号和商户侧单号；枚举值2，使用微信支付单号。
+	OrderNumberType NumberType `json:"order_number_type"` // 订单单号类型，用于确认需要上传详情的订单。枚举值 1，使用下单商户号和商户侧单号；枚举值 2，使用微信支付单号。
 	TransactionID   string     `json:"transaction_id"`    // 原支付交易对应的微信订单号
 	Mchid           string     `json:"mchid"`             // 支付下单商户的商户号，由微信支付生成并下发
-	OutTradeNo      string     `json:"out_trade_no"`      // 商户系统内部订单号，只能是数字、大小写字母`_-*`且在同一个商户号下唯一
+	OutTradeNo      string     `json:"out_trade_no"`      // 商户系统内部订单号，只能是数字、大小写字母 `_-*` 且在同一个商户号下唯一
 }

 // ShippingPayer 支付者信息
 type ShippingPayer struct {
-	Openid string `json:"openid"` // 用户标识，用户在小程序appid下的唯一标识
+	Openid string `json:"openid"` // 用户标识，用户在小程序 appid 下的唯一标识
 }

 // ShippingInfo 物流信息
 type ShippingInfo struct {
 	TrackingNo     string          `json:"tracking_no"`     // 物流单号，物流快递发货时必填
-	ExpressCompany string          `json:"express_company"` // 物流公司编码，快递公司ID，物流快递发货时必填；参见「查询物流公司编码列表」
-	ItemDesc       string          `json:"item_desc"`       // 商品信息，例如：微信红包抱枕*1个，限120个字以内
+	ExpressCompany string          `json:"express_company"` // 物流公司编码，快递公司 ID，物流快递发货时必填；参见「查询物流公司编码列表」
+	ItemDesc       string          `json:"item_desc"`       // 商品信息，例如：微信红包抱枕*1 个，限 120 个字以内
 	Contact        ShippingContact `json:"contact"`         // 联系方式，当发货的物流公司为顺丰时，联系方式为必填，收件人或寄件人联系方式二选一
 }

 // ShippingContact 联系方式
 type ShippingContact struct {
-	ConsignorContact string `json:"consignor_contact"` // 寄件人联系方式，寄件人联系方式，采用掩码传输，最后4位数字不能打掩码
-	ReceiverContact  string `json:"receiver_contact"`  // 收件人联系方式，收件人联系方式，采用掩码传输，最后4位数字不能打掩码
+	ConsignorContact string `json:"consignor_contact"` // 寄件人联系方式，寄件人联系方式，采用掩码传输，最后 4 位数字不能打掩码
+	ReceiverContact  string `json:"receiver_contact"`  // 收件人联系方式，收件人联系方式，采用掩码传输，最后 4 位数字不能打掩码
 }

 // DeliveryMode 发货模式
@@ -178,13 +178,13 @@ type GetShippingOrderRequest struct {
 	TransactionID   string `json:"transaction_id"`    // 原支付交易对应的微信订单号
 	MerchantID      string `json:"merchant_id"`       // 支付下单商户的商户号，由微信支付生成并下发
 	SubMerchantID   string `json:"sub_merchant_id"`   //二级商户号
-	MerchantTradeNo string `json:"merchant_trade_no"` //商户系统内部订单号，只能是数字、大小写字母`_-*`且在同一个商户号下唯一。
+	MerchantTradeNo string `json:"merchant_trade_no"` //商户系统内部订单号，只能是数字、大小写字母 `_-*` 且在同一个商户号下唯一。
 }

 // ShippingItem 物流信息
 type ShippingItem struct {
-	TrackingNo     string `json:"tracking_no"`     // 物流单号，示例值: "323244567777
-	ExpressCompany string `json:"express_company"` // 物流公司编码，快递公司ID，物流快递发货时必填；参见「查询物流公司编码列表」
+	TrackingNo     string `json:"tracking_no"`     // 物流单号，示例值："323244567777
+	ExpressCompany string `json:"express_company"` // 物流公司编码，快递公司 ID，物流快递发货时必填；参见「查询物流公司编码列表」
 	UploadTime     int64  `json:"upload_time"`     // 上传物流信息时间，时间戳形式
 }

@@ -201,12 +201,12 @@ type ShippingDetail struct {
 // ShippingOrder 订单发货状态
 type ShippingOrder struct {
 	TransactionID   string          `json:"transaction_id"`    // 原支付交易对应的微信订单号
-	MerchantTradeNo string          `json:"merchant_trade_no"` // 商户系统内部订单号，只能是数字、大小写字母`_-*`且在同一个商户号下唯一
+	MerchantTradeNo string          `json:"merchant_trade_no"` // 商户系统内部订单号，只能是数字、大小写字母 `_-*` 且在同一个商户号下唯一
 	MerchantID      string          `json:"merchant_id"`       // 支付下单商户的商户号，由微信支付生成并下发
 	SubMerchantID   string          `json:"sub_merchant_id"`   // 二级商户号
-	Description     string          `json:"description"`       // 以分号连接的该支付单的所有商品描述，当超过120字时自动截断并以 “...” 结尾
+	Description     string          `json:"description"`       // 以分号连接的该支付单的所有商品描述，当超过 120 字时自动截断并以“...”结尾
 	PaidAmount      int64           `json:"paid_amount"`       // 支付单实际支付金额，整型，单位：分钱
-	Openid          string          `json:"openid"`            // 支付者openid
+	Openid          string          `json:"openid"`            // 支付者 openid
 	TradeCreateTime int64           `json:"trade_create_time"` // 交易创建时间，时间戳形式
 	PayTime         int64           `json:"pay_time"`          // 支付时间，时间戳形式
 	InComplaint     bool            `json:"in_complaint"`      // 是否处在交易纠纷中
@@ -240,9 +240,9 @@ const (
 type GetShippingOrderListRequest struct {
 	PayTimeRange *TimeRange `json:"pay_time_range"`        // 支付时间范围
 	OrderState   State      `json:"order_state,omitempty"` // 订单状态
-	Openid       string     `json:"openid,omitempty"`      // 支付者openid
+	Openid       string     `json:"openid,omitempty"`      // 支付者 openid
 	LastIndex    string     `json:"last_index,omitempty"`  // 	翻页时使用，获取第一页时不用传入，如果查询结果中 has_more 字段为 true，则传入该次查询结果中返回的 last_index 字段可获取下一页
-	PageSize     int64      `json:"page_size"`             // 每页数量，最多50条
+	PageSize     int64      `json:"page_size"`             // 每页数量，最多 50 条
 }

 // TimeRange 时间范围
@@ -264,6 +264,6 @@ type NotifyConfirmReceiveRequest struct {
 	TransactionID   string `json:"transaction_id"`    // 原支付交易对应的微信订单号
 	MerchantID      string `json:"merchant_id"`       // 支付下单商户的商户号，由微信支付生成并下发
 	SubMerchantID   string `json:"sub_merchant_id"`   // 二级商户号
-	MerchantTradeNo string `json:"merchant_trade_no"` // 商户系统内部订单号，只能是数字、大小写字母`_-*`且在同一个商户号下唯一
+	MerchantTradeNo string `json:"merchant_trade_no"` // 商户系统内部订单号，只能是数字、大小写字母 `_-*` 且在同一个商户号下唯一
 	ReceivedTime    int64  `json:"received_time"`     // 收货时间，时间戳形式
 }
--- a/miniprogram/privacy/privacy.go
+++ b/miniprogram/privacy/privacy.go
@@ -53,9 +53,9 @@ const (
 	getPrivacySettingURL    = "https://api.weixin.qq.com/cgi-bin/component/getprivacysetting"
 	uploadPrivacyExtFileURL = "https://api.weixin.qq.com/cgi-bin/component/uploadprivacyextfile"

-	// PrivacyV1 用户隐私保护指引的版本，1表示现网版本。
+	// PrivacyV1 用户隐私保护指引的版本，1 表示现网版本。
 	PrivacyV1 = 1
-	// PrivacyV2 2表示开发版。默认是2开发版。
+	// PrivacyV2 2 表示开发版。默认是 2 开发版。
 	PrivacyV2 = 2
 )

@@ -77,12 +77,12 @@ type SettingResponseItem struct {
 	PrivacyLabel string `json:"privacy_label"`
 }

-// DescList 权限列表(保持与官方一致)
+// DescList 权限列表 (保持与官方一致)
 type DescList struct {
 	PrivacyDescList []Desc `json:"privacy_desc_list"`
 }

-// Desc 权限列表明细(保持与官方一致)
+// Desc 权限列表明细 (保持与官方一致)
 type Desc struct {
 	PrivacyDesc string `json:"privacy_desc"`
 	PrivacyKey  string `json:"privacy_key"`
@@ -110,7 +110,7 @@ func (s *Privacy) GetPrivacySetting(privacyVer int) (GetPrivacySettingResponse,
 // SetPrivacySetting 更新小程序权限配置
 func (s *Privacy) SetPrivacySetting(privacyVer int, ownerSetting OwnerSetting, settingList []SettingItem) error {
 	if privacyVer == PrivacyV1 && len(settingList) > 0 {
-		return errors.New("当privacy_ver传2或者不传时，setting_list是必填；当privacy_ver传1时，该参数不可传")
+		return errors.New("当 privacy_ver 传 2 或者不传时，setting_list 是必填；当 privacy_ver 传 1 时，该参数不可传")
 	}
 	accessToken, err := s.GetAccessToken()
 	if err != nil {
--- a/miniprogram/qrcode/qrcode.go
+++ b/miniprogram/qrcode/qrcode.go
@@ -36,21 +36,21 @@ type Color struct {

 // QRCoder 小程序码参数
 type QRCoder struct {
-	// page 必须是已经发布的小程序存在的页面,根路径前不要填加 /,不能携带参数（参数请放在scene字段里），如果不填写这个字段，默认跳主页面
+	// page 必须是已经发布的小程序存在的页面，根路径前不要填加 /,不能携带参数（参数请放在 scene 字段里），如果不填写这个字段，默认跳主页面
 	Page string `json:"page,omitempty"`
 	// path 扫码进入的小程序页面路径
 	Path string `json:"path,omitempty"`
-	// checkPath 检查page 是否存在，为 true 时 page 必须是已经发布的小程序存在的页面（否则报错）；为 false 时允许小程序未发布或者 page 不存在， 但page 有数量上限（60000个）请勿滥用，默认true
+	// checkPath 检查 page 是否存在，为 true 时 page 必须是已经发布的小程序存在的页面（否则报错）；为 false 时允许小程序未发布或者 page 不存在，但 page 有数量上限（60000 个）请勿滥用，默认 true
 	CheckPath *bool `json:"check_path,omitempty"`
 	// width 图片宽度
 	Width int `json:"width,omitempty"`
-	// scene 最大32个可见字符，只支持数字，大小写英文以及部分特殊字符：!#$&'()*+,/:;=?@-._~，其它字符请自行编码为合法字符（因不支持%，中文无法使用 urlencode 处理，请使用其他编码方式）
+	// scene 最大 32 个可见字符，只支持数字，大小写英文以及部分特殊字符：!#$&'()*+,/:;=?@-._~，其它字符请自行编码为合法字符（因不支持%，中文无法使用 urlencode 处理，请使用其他编码方式）
 	Scene string `json:"scene,omitempty"`
-	// autoColor 自动配置线条颜色，如果颜色依然是黑色，则说明不建议配置主色调，默认false
+	// autoColor 自动配置线条颜色，如果颜色依然是黑色，则说明不建议配置主色调，默认 false
 	AutoColor bool `json:"auto_color,omitempty"`
 	// lineColor AutoColor 为 false 时生效，使用 rgb 设置颜色 例如 {"r":"xxx","g":"xxx","b":"xxx"},十进制表示
 	LineColor *Color `json:"line_color,omitempty"`
-	// isHyaline 是否需要透明底色，默认false
+	// isHyaline 是否需要透明底色，默认 false
 	IsHyaline bool `json:"is_hyaline,omitempty"`
 	// envVersion 要打开的小程序版本。正式版为 "release"，体验版为 "trial"，开发版为 "develop"
 	EnvVersion string `json:"env_version,omitempty"`
@@ -88,19 +88,19 @@ func (qrCode *QRCode) fetchCode(urlStr string, body interface{}) (response []byt
 }

 // CreateWXAQRCode 获取小程序二维码，适用于需要的码数量较少的业务场景
-// 文档地址： https://developers.weixin.qq.com/miniprogram/dev/api/createWXAQRCode.html
+// 文档地址：https://developers.weixin.qq.com/miniprogram/dev/api/createWXAQRCode.html
 func (qrCode *QRCode) CreateWXAQRCode(coderParams QRCoder) (response []byte, err error) {
 	return qrCode.fetchCode(createWXAQRCodeURL, coderParams)
 }

 // GetWXACode 获取小程序码，适用于需要的码数量较少的业务场景
-// 文档地址： https://developers.weixin.qq.com/miniprogram/dev/api/getWXACode.html
+// 文档地址：https://developers.weixin.qq.com/miniprogram/dev/api/getWXACode.html
 func (qrCode *QRCode) GetWXACode(coderParams QRCoder) (response []byte, err error) {
 	return qrCode.fetchCode(getWXACodeURL, coderParams)
 }

 // GetWXACodeUnlimit 获取小程序码，适用于需要的码数量极多的业务场景
-// 文档地址： https://developers.weixin.qq.com/miniprogram/dev/api/getWXACodeUnlimit.html
+// 文档地址：https://developers.weixin.qq.com/miniprogram/dev/api/getWXACodeUnlimit.html
 func (qrCode *QRCode) GetWXACodeUnlimit(coderParams QRCoder) (response []byte, err error) {
 	return qrCode.fetchCode(getWXACodeUnlimitURL, coderParams)
 }
--- a/miniprogram/redpacketcover/redpacketcover.go
+++ b/miniprogram/redpacketcover/redpacketcover.go
@@ -25,9 +25,9 @@ func NewRedPacketCover(context *context.Context) *RedPacketCover {

 // GetRedPacketCoverRequest 获取微信红包封面参数
 type GetRedPacketCoverRequest struct {
-	// openid 可领取用户的openid
+	// openid 可领取用户的 openid
 	OpenID string `json:"openid"`
-	// ctoken 在红包封面平台获取发放ctoken（需要指定可以发放的appid）
+	// ctoken 在红包封面平台获取发放 ctoken（需要指定可以发放的 appid）
 	CToken string `json:"ctoken"`
 }

@@ -39,8 +39,8 @@ type GetRedPacketCoverResp struct {
 	} `json:"data"` // 唯一请求标识
 }

-// GetRedPacketCoverURL 获得指定用户可以领取的红包封面链接。获取参数ctoken参考微信红包封面开放平台
-// 文档地址： https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/red-packet-cover/getRedPacketCoverUrl.html
+// GetRedPacketCoverURL 获得指定用户可以领取的红包封面链接。获取参数 ctoken 参考微信红包封面开放平台
+// 文档地址：https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/red-packet-cover/getRedPacketCoverUrl.html
 func (cover *RedPacketCover) GetRedPacketCoverURL(coderParams GetRedPacketCoverRequest) (res GetRedPacketCoverResp, err error) {
 	accessToken, err := cover.GetAccessToken()
 	if err != nil {
--- a/miniprogram/riskcontrol/riskcontrol.go
+++ b/miniprogram/riskcontrol/riskcontrol.go
@@ -26,7 +26,7 @@ type UserRiskRankRequest struct {
 	AppID    string `json:"appid"`     // 小程序 app id
 	OpenID   string `json:"openid"`    // 用户的 openid
 	Scene    uint8  `json:"scene"`     // 场景值，0:注册，1:营销作弊
-	ClientIP string `json:"client_ip"` // 用户访问源ip
+	ClientIP string `json:"client_ip"` // 用户访问源 ip

 	Mobile       string `json:"mobile_no"`     // 用户手机号
 	Email        string `json:"email_address"` // 用户邮箱地址
--- a/miniprogram/security/security.go
+++ b/miniprogram/security/security.go
@@ -26,13 +26,13 @@ func NewSecurity(ctx *context.Context) *Security {

 // MediaCheckAsyncV1Request 图片/音频异步校验请求参数
 type MediaCheckAsyncV1Request struct {
-	MediaURL  string `json:"media_url"`  // 要检测的图片或音频的url，支持图片格式包括jpg, jepg, png, bmp, gif（取首帧），支持的音频格式包括mp3, aac, ac3, wma, flac, vorbis, opus, wav
+	MediaURL  string `json:"media_url"`  // 要检测的图片或音频的 url，支持图片格式包括 jpg, jepg, png, bmp, gif（取首帧），支持的音频格式包括 mp3, aac, ac3, wma, flac, vorbis, opus, wav
 	MediaType uint8  `json:"media_type"` // 1:音频;2:图片
 }

 // MediaCheckAsyncV1 异步校验图片/音频是否含有违法违规内容
 // Deprecated
-// 在2021年9月1日停止更新，请尽快更新至 2.0 接口。建议使用 MediaCheckAsync
+// 在 2021 年 9 月 1 日停止更新，请尽快更新至 2.0 接口。建议使用 MediaCheckAsync
 func (security *Security) MediaCheckAsyncV1(in *MediaCheckAsyncV1Request) (traceID string, err error) {
 	accessToken, err := security.GetAccessToken()
 	if err != nil {
@@ -56,9 +56,9 @@ func (security *Security) MediaCheckAsyncV1(in *MediaCheckAsyncV1Request) (trace

 // MediaCheckAsyncRequest 图片/音频异步校验请求参数
 type MediaCheckAsyncRequest struct {
-	MediaURL  string `json:"media_url"`  // 要检测的图片或音频的url，支持图片格式包括jpg, jepg, png, bmp, gif（取首帧），支持的音频格式包括mp3, aac, ac3, wma, flac, vorbis, opus, wav
+	MediaURL  string `json:"media_url"`  // 要检测的图片或音频的 url，支持图片格式包括 jpg, jepg, png, bmp, gif（取首帧），支持的音频格式包括 mp3, aac, ac3, wma, flac, vorbis, opus, wav
 	MediaType uint8  `json:"media_type"` // 1:音频;2:图片
-	OpenID    string `json:"openid"`     // 用户的openid（用户需在近两小时访问过小程序）
+	OpenID    string `json:"openid"`     // 用户的 openid（用户需在近两小时访问过小程序）
 	Scene     uint8  `json:"scene"`      // 场景枚举值（1 资料；2 评论；3 论坛；4 社交日志）
 }

@@ -71,7 +71,7 @@ func (security *Security) MediaCheckAsync(in *MediaCheckAsyncRequest) (traceID s

 	var req struct {
 		MediaCheckAsyncRequest
-		Version uint `json:"version"` // 接口版本号，2.0版本为固定值2
+		Version uint `json:"version"` // 接口版本号，2.0 版本为固定值 2
 	}
 	req.MediaCheckAsyncRequest = *in
 	req.Version = 2
@@ -94,7 +94,7 @@ func (security *Security) MediaCheckAsync(in *MediaCheckAsyncRequest) (traceID s
 // ImageCheckV1 校验一张图片是否含有违法违规内容（同步）
 // https://developers.weixin.qq.com/miniprogram/dev/framework/security.imgSecCheck.html
 // Deprecated
-// 在2021年9月1日停止更新。建议使用 MediaCheckAsync
+// 在 2021 年 9 月 1 日停止更新。建议使用 MediaCheckAsync
 func (security *Security) ImageCheckV1(filename string) (err error) {
 	accessToken, err := security.GetAccessToken()
 	if err != nil {
@@ -169,12 +169,12 @@ func (cl CheckLabel) String() string {

 // MsgCheckRequest 文本检查请求
 type MsgCheckRequest struct {
-	OpenID    string   `json:"openid"`    // 用户的openid（用户需在近两小时访问过小程序）
+	OpenID    string   `json:"openid"`    // 用户的 openid（用户需在近两小时访问过小程序）
 	Scene     MsgScene `json:"scene"`     // 场景枚举值（1 资料；2 评论；3 论坛；4 社交日志）
 	Content   string   `json:"content"`   // 需检测的文本内容，文本字数的上限为 2500 字，需使用 UTF-8 编码
-	Nickname  string   `json:"nickname"`  // （非必填）用户昵称，需使用UTF-8编码
-	Title     string   `json:"title"`     // （非必填）文本标题，需使用UTF-8编码
-	Signature string   `json:"signature"` // （非必填）个性签名，该参数仅在资料类场景有效(scene=1)，需使用UTF-8编码
+	Nickname  string   `json:"nickname"`  // （非必填）用户昵称，需使用 UTF-8 编码
+	Title     string   `json:"title"`     // （非必填）文本标题，需使用 UTF-8 编码
+	Signature string   `json:"signature"` // （非必填）个性签名，该参数仅在资料类场景有效 (scene=1)，需使用 UTF-8 编码
 }

 // MsgCheckResponse 文本检查响应
@@ -186,7 +186,7 @@ type MsgCheckResponse struct {
 		Label   CheckLabel   `json:"label"`   // 命中标签
 	} `json:"result"` // 综合结果
 	Detail []struct {
-		ErrCode  int64      `json:"errcode"`  // 错误码，仅当该值为0时，该项结果有效
+		ErrCode  int64      `json:"errcode"`  // 错误码，仅当该值为 0 时，该项结果有效
 		Strategy string     `json:"strategy"` // 策略类型
 		Suggest  string     `json:"suggest"`  // 建议
 		Label    CheckLabel `json:"label"`    // 命中标签
@@ -197,7 +197,7 @@ type MsgCheckResponse struct {

 // MsgCheckV1 检查一段文本是否含有违法违规内容
 // Deprecated
-// 在2021年9月1日停止更新，请尽快更新至 2.0 接口。建议使用 MsgCheck
+// 在 2021 年 9 月 1 日停止更新，请尽快更新至 2.0 接口。建议使用 MsgCheck
 func (security *Security) MsgCheckV1(content string) (res MsgCheckResponse, err error) {
 	accessToken, err := security.GetAccessToken()
 	if err != nil {
--- a/miniprogram/subscribe/subscribe.go
+++ b/miniprogram/subscribe/subscribe.go
@@ -42,11 +42,11 @@ func NewSubscribe(ctx *context.Context) *Subscribe {
 // Message 订阅消息请求参数
 type Message struct {
 	ToUser           string               `json:"touser"`            // 必选，接收者（用户）的 openid
-	TemplateID       string               `json:"template_id"`       // 必选，所需下发的订阅模板id
-	Page             string               `json:"page"`              // 可选，点击模板卡片后的跳转页面，仅限本小程序内的页面。支持带参数,（示例index?foo=bar）。该字段不填则模板无跳转。
-	Data             map[string]*DataItem `json:"data"`              // 必选, 模板内容
-	MiniprogramState string               `json:"miniprogram_state"` // 可选，跳转小程序类型：developer为开发版；trial为体验版；formal为正式版；默认为正式版
-	Lang             string               `json:"lang"`              // 入小程序查看”的语言类型，支持zh_CN(简体中文)、en_US(英文)、zh_HK(繁体中文)、zh_TW(繁体中文)，默认为zh_CN
+	TemplateID       string               `json:"template_id"`       // 必选，所需下发的订阅模板 id
+	Page             string               `json:"page"`              // 可选，点击模板卡片后的跳转页面，仅限本小程序内的页面。支持带参数，（示例 index?foo=bar）。该字段不填则模板无跳转。
+	Data             map[string]*DataItem `json:"data"`              // 必选，模板内容
+	MiniprogramState string               `json:"miniprogram_state"` // 可选，跳转小程序类型：developer 为开发版；trial 为体验版；formal 为正式版；默认为正式版
+	Lang             string               `json:"lang"`              // 入小程序查看”的语言类型，支持 zh_CN(简体中文)、en_US(英文)、zh_HK(繁体中文)、zh_TW(繁体中文)，默认为 zh_CN
 }

 // DataItem 模版内某个 .DATA 的值
--- a/miniprogram/tcb/README.md
+++ b/miniprogram/tcb/README.md
@@ -1,4 +1,4 @@
-# 小程序-云开发 SDK
+# 小程序 - 云开发 SDK

 Tencent Cloud Base [文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/)

--- a/miniprogram/tcb/cloudfunction.go
+++ b/miniprogram/tcb/cloudfunction.go
@@ -14,7 +14,7 @@ const (
 // InvokeCloudFunctionRes 云函数调用返回结果
 type InvokeCloudFunctionRes struct {
 	util.CommonError
-	RespData string `json:"resp_data"` // 云函数返回的buffer
+	RespData string `json:"resp_data"` // 云函数返回的 buffer
 }

 // InvokeCloudFunction 云函数调用
--- a/miniprogram/tcb/database.go
+++ b/miniprogram/tcb/database.go
@@ -49,13 +49,13 @@ type ConflictMode int
 // FileType 文件上传和导出的允许文件类型
 type FileType int

-// ValidDirections 合法的direction值
+// ValidDirections 合法的 direction 值
 var ValidDirections = []string{"1", "-1", "2dsphere"}

 // DatabaseMigrateExportReq 数据库出 请求参数
 type DatabaseMigrateExportReq struct {
-	Env      string   `json:"env,omitempty"`       // 云环境ID
-	FilePath string   `json:"file_path,omitempty"` // 导出文件路径(导入文件需先上传到同环境的存储中，可使用开发者工具或 HTTP API的上传文件 API上传）
+	Env      string   `json:"env,omitempty"`       // 云环境 ID
+	FilePath string   `json:"file_path,omitempty"` // 导出文件路径 (导入文件需先上传到同环境的存储中，可使用开发者工具或 HTTP API 的上传文件 API 上传）
 	FileType FileType `json:"file_type,omitempty"` // 导出文件类型，文件格式参考数据库导入指引中的文件格式部分  1:json 2:csv
 	Query    string   `json:"query,omitempty"`     // 导出条件
 }
@@ -63,12 +63,12 @@ type DatabaseMigrateExportReq struct {
 // DatabaseMigrateExportRes 数据库导出 返回结果
 type DatabaseMigrateExportRes struct {
 	util.CommonError
-	JobID int64 `json:"job_id"` // 导出任务ID，可使用数据库迁移进度查询 API 查询导入进度及结果
+	JobID int64 `json:"job_id"` // 导出任务 ID，可使用数据库迁移进度查询 API 查询导入进度及结果
 }

 // DatabaseMigrateImportReq 数据库导入 请求参数
 type DatabaseMigrateImportReq struct {
-	Env            string       `json:"env,omitempty"`             // 云环境ID
+	Env            string       `json:"env,omitempty"`             // 云环境 ID
 	CollectionName string       `json:"collection_name,omitempty"` // 集合名称
 	FilePath       string       `json:"file_path,omitempty"`       // 导出文件路径（文件会导出到同环境的云存储中，可使用获取下载链接 API 获取下载链接）
 	FileType       FileType     `json:"file_type,omitempty"`       // 导入文件类型，文件格式参考数据库导入指引中的文件格式部分  1:json 2:csv
@@ -79,7 +79,7 @@ type DatabaseMigrateImportReq struct {
 // DatabaseMigrateImportRes 数据库导入 返回结果
 type DatabaseMigrateImportRes struct {
 	util.CommonError
-	JobID int64 `json:"job_id"` // 导入任务ID，可使用数据库迁移进度查询 API 查询导入进度及结果
+	JobID int64 `json:"job_id"` // 导入任务 ID，可使用数据库迁移进度查询 API 查询导入进度及结果
 }

 // DatabaseMigrateQueryInfoRes 数据库迁移状态查询
@@ -94,7 +94,7 @@ type DatabaseMigrateQueryInfoRes struct {

 // UpdateIndexReq 变更数据库索引 请求参数
 type UpdateIndexReq struct {
-	Env            string        `json:"env,omitempty"`             // 云环境ID
+	Env            string        `json:"env,omitempty"`             // 云环境 ID
 	CollectionName string        `json:"collection_name,omitempty"` // 集合名称
 	CreateIndexes  []CreateIndex `json:"create_indexes,omitempty"`  // 新增索引
 	DropIndexes    []DropIndex   `json:"drop_indexes,omitempty"`    // 删除索引
@@ -120,13 +120,13 @@ type DropIndex struct {

 // DatabaseCollectionReq 新增/删除集合请求参数
 type DatabaseCollectionReq struct {
-	Env            string `json:"env,omitempty"`             // 云环境ID
+	Env            string `json:"env,omitempty"`             // 云环境 ID
 	CollectionName string `json:"collection_name,omitempty"` // 集合名称
 }

 // DatabaseCollectionGetReq 获取特定云环境下集合信息请求
 type DatabaseCollectionGetReq struct {
-	Env    string `json:"env,omitempty"`    // 云环境ID
+	Env    string `json:"env,omitempty"`    // 云环境 ID
 	Limit  int64  `json:"limit,omitempty"`  // 获取数量限制
 	Offset int64  `json:"offset,omitempty"` // 偏移量
 }
@@ -150,7 +150,7 @@ type DatabaseCollectionGetRes struct {

 // DatabaseReq 数据库插入/删除/更新/查询/统计记录请求参数
 type DatabaseReq struct {
-	Env   string `json:"env,omitempty"`   // 云环境ID
+	Env   string `json:"env,omitempty"`   // 云环境 ID
 	Query string `json:"query,omitempty"` // 数据库操作语句
 }

@@ -170,7 +170,7 @@ type DatabaseDeleteRes struct {
 type DatabaseUpdateRes struct {
 	util.CommonError
 	Matched  int64  `json:"matched"`  // 更新条件匹配到的结果数
-	Modified int64  `json:"modified"` // 修改的记录数，注意：使用set操作新插入的数据不计入修改数目
+	Modified int64  `json:"modified"` // 修改的记录数，注意：使用 set 操作新插入的数据不计入修改数目
 	ID       string `json:"id"`
 }

--- a/miniprogram/tcb/file.go
+++ b/miniprogram/tcb/file.go
@@ -24,11 +24,11 @@ type UploadFileReq struct {
 // UploadFileRes 上传文件返回结果
 type UploadFileRes struct {
 	util.CommonError
-	URL           string `json:"url"`           // 上传url
+	URL           string `json:"url"`           // 上传 url
 	Token         string `json:"token"`         // token
 	Authorization string `json:"authorization"` // authorization
-	FileID        string `json:"file_id"`       // 文件ID
-	CosFileID     string `json:"cos_file_id"`   // cos文件ID
+	FileID        string `json:"file_id"`       // 文件 ID
+	CosFileID     string `json:"cos_file_id"`   // cos 文件 ID
 }

 // BatchDownloadFileReq 上传文件请求值
@@ -39,7 +39,7 @@ type BatchDownloadFileReq struct {

 // DownloadFile 文件信息
 type DownloadFile struct {
-	FileID string `json:"fileid"`  // 文件ID
+	FileID string `json:"fileid"`  // 文件 ID
 	MaxAge int64  `json:"max_age"` // 下载链接有效期
 }

@@ -47,7 +47,7 @@ type DownloadFile struct {
 type BatchDownloadFileRes struct {
 	util.CommonError
 	FileList []struct {
-		FileID      string `json:"file_id"`      // 文件ID
+		FileID      string `json:"file_id"`      // 文件 ID
 		DownloadURL string `json:"download_url"` // 下载链接
 		Status      int64  `json:"status"`       // 状态码
 		ErrMsg      string `json:"errmsg"`       // 该文件错误信息
--- a/miniprogram/urllink/urllink.go
+++ b/miniprogram/urllink/urllink.go
@@ -51,7 +51,7 @@ type ULResult struct {
 	URLLink string `json:"url_link"`
 }

-// Generate 生成url link
+// Generate 生成 url link
 func (u *URLLink) Generate(params *ULParams) (string, error) {
 	accessToken, err := u.GetAccessToken()
 	if err != nil {
--- a/miniprogram/urlscheme/query.go
+++ b/miniprogram/urlscheme/query.go
@@ -10,7 +10,7 @@ const (
 	querySchemeURL = "https://api.weixin.qq.com/wxa/queryscheme?access_token=%s"
 )

-// QueryScheme 获取小程序访问scheme
+// QueryScheme 获取小程序访问 scheme
 // https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/url-scheme/urlscheme.query.html#参数
 type QueryScheme struct {
 	// 小程序 scheme 码
@@ -23,7 +23,7 @@ type SchemeInfo struct {
 	AppID string `json:"appid"`
 	// 小程序页面路径。
 	Path string `json:"path"`
-	// 小程序页面query。
+	// 小程序页面 query。
 	Query string `json:"query"`
 	// 创建时间，为 Unix 时间戳。
 	CreateTime int64 `json:"create_time"`
@@ -40,7 +40,7 @@ type resQueryScheme struct {
 	util.CommonError
 	// scheme 配置
 	SchemeInfo SchemeInfo `json:"scheme_info"`
-	// 访问该链接的openid，没有用户访问过则为空字符串
+	// 访问该链接的 openid，没有用户访问过则为空字符串
 	VisitOpenid string `json:"visit_openid"`
 }

--- a/miniprogram/urlscheme/urlscheme.go
+++ b/miniprogram/urlscheme/urlscheme.go
@@ -64,7 +64,7 @@ type USResult struct {
 	OpenLink string `json:"openlink"`
 }

-// Generate 生成url link
+// Generate 生成 url link
 func (u *URLScheme) Generate(params *USParams) (string, error) {
 	accessToken, err := u.GetAccessToken()
 	if err != nil {
--- a/miniprogram/virtualpayment/domain.go
+++ b/miniprogram/virtualpayment/domain.go
@@ -136,7 +136,7 @@ type OrderItem struct {
 	PaidFee        int         `json:"paid_fee"`         // 用户支付金额，单位：分
 	OrderType      int         `json:"order_type"`       // 订单类型 0-支付单 1-退款单
 	RefundFee      int         `json:"refund_fee"`       // 当类型为退款单时表示退款金额，单位分
-	PaidTime       int64       `json:"paid_time"`        // 支付/退款时间，unix秒级时间戳
+	PaidTime       int64       `json:"paid_time"`        // 支付/退款时间，unix 秒级时间戳
 	ProvideTime    int64       `json:"provide_time"`     // 发货时间，unix 秒级时间戳
 	BizMeta        string      `json:"biz_meta"`         // 业务自定义数据 订单创建时传的信息
 	EnvType        int         `json:"env_type"`         // 环境类型 1-现网 2-沙箱