Skip to content

Commit

Permalink
docs: 修正文档错误
Browse files Browse the repository at this point in the history
  • Loading branch information
caixw committed Dec 3, 2024
1 parent be8cc8d commit 4601d86
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 4 deletions.
7 changes: 6 additions & 1 deletion comptime/comptime.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,11 @@
// go 以 //go:build 的方式区别编译内容,目前支持以下标签:
// - development 表示开发环境,[Mode] 会被赋为 [Development];
// - 其它情况下,则 [Mode] 的值永远是 [Production];
//
// 在 go build 命令行中可以使用 -tags=development 指定为开发模式,
// 或是使用 [web] 时添加 dev 参数;
//
// [web] https://pkg.go.dev/github.com/issue9/web/cmd/web
package comptime

const (
Expand All @@ -27,5 +32,5 @@ const Mode = defaultMode
// - [Development] 在扩展名前加上 _development,比如 file.yaml => file_development.yaml;
//
// 一般像根据环境加载不同的配置文件之类的功能可以使用此方法。
// 比如 [server/app.CLI.ConfigFilename] 可以使用此文件指定相同的文件名
// 比如 [server/app.CLI.ConfigFilename] 可以使用此函数指定不同的文件名
func Filename(f string) string { return filename(f) }
2 changes: 1 addition & 1 deletion mimetype/form/form.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
// return web.Object(http.StatusOK, vals, nil)
// }
//
// ## form 标签
// # form 标签
//
// 用户可以通过定义 form 标签自定义输出的名称,比如:
//
Expand Down
4 changes: 2 additions & 2 deletions openapi/openapi.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
// Package openapi 采用 [web.Middleware] 中间件的形式生成 [openapi] 文档
//
// 结构体标签
// - [CommentTag] 用于可翻译的注释,该内容会被翻译后保存在字段的 Schema.Description 中;
// - [CommentTag] 用于可翻译的注释,该内容会被翻译后保存在 [Schema.Description] 中;
// - openapi 对 openapi 类型的自定义,格式为 type,format,可以自定义字段的类型和格式;
//
// # Schema
Expand All @@ -30,7 +30,7 @@
// s.Enum = []string {"stopped", "running" }
// }
//
// 以上代码,会在解析 State 始终采用 OpenAPISchema 修改。
// 以上代码,会在解析 State 始终采用 [OpenAPISchema] 修改。
//
// 结构体标签的优先级要高于 [OpenAPISchema] 接口。
//
Expand Down

0 comments on commit 4601d86

Please sign in to comment.