Skip to content

Commit d65b407

Browse files
committed
Update document
1 parent 5336661 commit d65b407

7 files changed

Lines changed: 45 additions & 9 deletions

File tree

document/config.mts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ export default defineAdditionalConfig({
5454
{ text: "Project Wizard", link: "project-wizard" },
5555
{ text: "Navigate", link: "navigate" },
5656
{ text: "SQL to Clipboard", link: "sql-to-clipboard" },
57-
{ text: "Inlay Hit", link: "inlay-hit" },
57+
{ text: "Inlay Hints", link: "inlay-hints" },
5858
{ text: "Postfix Template", link: "postfix-template" },
5959
],
6060
},

document/en/reference/feature-inlay-hit.md renamed to document/en/reference/feature-inlay-hints.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Inlay Hit
1+
# Inlay Hints
22

33
## DTO Types
44

@@ -14,4 +14,10 @@ Show the `@MappedSuperclass` have inheritors.
1414

1515
![20250524215019](https://s2.loli.net/2025/05/24/ixyDUvYCQb6mJMa.png)
1616

17-
And you can click the type to jump to the inheritors.
17+
And you can click the type to jump to the inheritors.
18+
19+
## Select
20+
21+
Show the real name of multi-column selects.
22+
23+
![20250810174911](https://s2.loli.net/2025/08/10/SDrWXaNQFHwEURJ.png)

document/en/reference/feature-inspection.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,3 +49,15 @@ Checks for correct usage of immutable-related annotations such as `@Immutable`,
4949
Checks the `@OrderedProp` annotation:
5050

5151
- The `value` property must exist.
52+
53+
## Database Checks
54+
55+
Ensure that the table is cached in the database list first.
56+
57+
Checks the `@Table` annotation:
58+
- The `name` property must exist in the database.
59+
- The class name must exist in the database.
60+
61+
Checks the `@Column` annotation:
62+
- The `name` property must exist in the database.
63+
- The property name must exist in the database.

document/en/reference/feature-postfix-template.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ ImmutableObjects.set(draft, )
7979
## Query: Create a Query (Kotlin)
8080

8181
```kotlin
82-
Author.query
82+
Author.cq
8383
```
8484

8585
Expands to:
@@ -93,7 +93,7 @@ sql.createQuery(Author::class) {
9393
## Update: Create an Update (Kotlin)
9494

9595
```kotlin
96-
Author.update
96+
Author.cu
9797
```
9898

9999
Expands to:
@@ -107,7 +107,7 @@ sql.createUpdate(Author::class) {
107107
## Delete: Create a Delete (Kotlin)
108108

109109
```kotlin
110-
Author.delete
110+
Author.cd
111111
```
112112

113113
Expands to:

document/zh/config.mts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ export default defineAdditionalConfig({
5454
{ text: "项目向导", link: "project-wizard" },
5555
{ text: "导航", link: "navigate" },
5656
{ text: "SQL 到剪贴板", link: "sql-to-clipboard" },
57-
{ text: "内联提示", link: "inlay-hit" },
57+
{ text: "嵌入提示", link: "inlay-hints" },
5858
{ text: "后缀模板", link: "postfix-template" },
5959
],
6060
},

document/zh/reference/feature-inlay-hit.md renamed to document/zh/reference/feature-inlay-hints.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,16 @@
88

99
并且可以点击类型跳转到 DTO 定义。
1010

11-
## Inheritors
11+
## 继承
1212

1313
显示 `@MappedSuperclass` 的子类。
1414

1515
![20250524215019](https://s2.loli.net/2025/05/24/ixyDUvYCQb6mJMa.png)
1616

17-
并且可以点击类型跳转到子类定义。
17+
并且可以点击类型跳转到子类定义。
18+
19+
## 选择
20+
21+
显示多列选择的真实名称。
22+
23+
![20250810174911](https://s2.loli.net/2025/08/10/SDrWXaNQFHwEURJ.png)

document/zh/reference/feature-inspection.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,3 +49,15 @@ JimmerBuddy 提供了多种检查功能,帮助你发现代码中的问题。
4949
检查 `@OrderedProp` 注解:
5050

5151
- 必须存在 `value` 属性。
52+
53+
## 数据库检查
54+
55+
需要优先在数据库列表中缓存表。
56+
57+
检查 `@Table` 注解:
58+
- `name` 属性必须存在于数据库中。
59+
- 类名必须存在于数据库中。
60+
61+
检查 `@Column` 注解:
62+
- `name` 属性必须存在于数据库中。
63+
- 属性名必须存在于数据库中。

0 commit comments

Comments
 (0)