Merge pull request #113 from shalousun/master

docs: Optimize the usage instructions for the @mock tag
smart-doc-group · Sep 7, 2024 · 7b037f0 · 7b037f0
2 parents 79b42b8 + 7c5eb69
commit 7b037f0
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/docs/en/guide/guide.md b/docs/en/guide/guide.md
@@ -193,6 +193,9 @@ public class InvoiceController {
 ```
 
 ### 2. `@mock`
+The `@mock` tag is used to set custom display values for basic type fields in objects. Once set, `smart-doc` will no longer generate random values for you.
+This facilitates direct output of delivery documents through `smart-doc`. `smart-doc` treats the attribute value of the `@mock` tag by unescape any literals in `{@mock String}`.
+If line breaks are needed in the content, do not use `\n`; simply perform line breaks directly within the comment.
 
 ```java
 public class SimpleUser {

diff --git a/docs/zh/guide/guide.md b/docs/zh/guide/guide.md
@@ -205,6 +205,9 @@ public class InvoiceController {
 
 
 ### 2. `@mock`
+`@mock` `tag`用于在对象基本类型字段设置自定义文档展示值。设置值后`smart-doc`不再帮你生成随机值。
+方便可以通过`smart-doc`直接输出交付文档。`smart-doc`会将`@mock`标签的属性值做将`{@mock String}`中的任何字面量取消转义。
+如果内容需要换行不要使用`\n`， 就直接在注释里做换行。
 
 ```java
 public class SimpleUser {