From 4601d86e4be135a82fdaafc68ff092a86c8bd5cf Mon Sep 17 00:00:00 2001
From: caixw <xnotepad@gmail.com>
Date: Tue, 3 Dec 2024 13:23:01 +0800
Subject: [PATCH] =?UTF-8?q?docs:=20=E4=BF=AE=E6=AD=A3=E6=96=87=E6=A1=A3?=
 =?UTF-8?q?=E9=94=99=E8=AF=AF?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 comptime/comptime.go  | 7 ++++++-
 mimetype/form/form.go | 2 +-
 openapi/openapi.go    | 4 ++--
 3 files changed, 9 insertions(+), 4 deletions(-)

diff --git a/comptime/comptime.go b/comptime/comptime.go
index 723cd1bb..30cc8257 100644
--- a/comptime/comptime.go
+++ b/comptime/comptime.go
@@ -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 (
@@ -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) }
diff --git a/mimetype/form/form.go b/mimetype/form/form.go
index 4f227b71..be40b92b 100644
--- a/mimetype/form/form.go
+++ b/mimetype/form/form.go
@@ -15,7 +15,7 @@
 //	    return web.Object(http.StatusOK, vals, nil)
 //	}
 //
-// ## form 标签
+// # form 标签
 //
 // 用户可以通过定义 form 标签自定义输出的名称，比如：
 //
diff --git a/openapi/openapi.go b/openapi/openapi.go
index c69f7aaf..123c7ba5 100644
--- a/openapi/openapi.go
+++ b/openapi/openapi.go
@@ -5,7 +5,7 @@
 // Package openapi 采用 [web.Middleware] 中间件的形式生成 [openapi] 文档
 //
 // 结构体标签
-//   - [CommentTag] 用于可翻译的注释，该内容会被翻译后保存在字段的 Schema.Description 中；
+//   - [CommentTag] 用于可翻译的注释，该内容会被翻译后保存在 [Schema.Description] 中；
 //   - openapi 对 openapi 类型的自定义，格式为 type,format，可以自定义字段的类型和格式；
 //
 // # Schema
@@ -30,7 +30,7 @@
 //		s.Enum = []string {"stopped", "running" }
 //	}
 //
-// 以上代码，会在解析 State 始终采用 OpenAPISchema 修改。
+// 以上代码，会在解析 State 始终采用 [OpenAPISchema] 修改。
 //
 // 结构体标签的优先级要高于 [OpenAPISchema] 接口。
 //