Skip to content

Commit

Permalink
imp: 以新的语法规则优化了指令描述,并带上了用例
Browse files Browse the repository at this point in the history
  • Loading branch information
fy0 committed Jun 21, 2024
1 parent 75c682c commit 92363e6
Showing 1 changed file with 28 additions and 4 deletions.
32 changes: 28 additions & 4 deletions docs/use/introduce.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,15 +79,39 @@ QQ 并未提供公开的机器人接口,因此机器人只能使用第三方

依照惯例,帮助说明中的的一些符号有特定含义,说明如下:

1. `<关键字>` 的尖括号 `<>` 表示你应以相应内容替换此处内容。
1. 不带有尖括号的内容是字面量,你应该原样输入这里的内容。

用例:`.find help`

2. `<内容>` 的尖括号 `<>` 表示你应以相应内容替换此处内容。

正常的用例:`.find 火球术`
错误的用例:`.find <火球术>`

2. 不带有尖括号的内容是字面量,你应该原样输入这里的内容。
3. `[关键字]` 的括号 `[]` 表示此参数可以被省略。
4. `(关键字1|关键字2)` 的圆括号 `()` 搭配竖线 `|` 表示必须在所列各项中选择一个。
3. `<内容1|内容2>``<内容>`类似,表示你可以写两种内容中的一种。

用例:`.pc rename <角色名|序号> <新角色名>`
正确用法:`.pc rename 伯瓦尔公爵 巫妖王` // 将“伯瓦尔公爵”改名为“巫妖王”
正确用法2:`.pc rename 1 巫妖王` // 将pc list中序号为1的卡片改名“巫妖王”

4. `[关键字]` 的括号 `[]` 表示此参数可以被省略。
用例:对于 `.log on [<日志名>]`
这是可以的:`.log on` // 继续记录当前的日志
这也是可以的:`.log on 去年6月5日下午4点04开跑的团` // 继续记录指定的日志

5. `[关键字1|关键字2]` 的方括号 `[]` 搭配竖线 `|` 表示可以在所列各项中选择一个,或不选择此项。
用例:对于`.name [cn|en|jp]`
用法1:`.name cn`
用法2:`.name en`
用法3:`.name jp`

6. `(关键字1|关键字2)` 的竖线 `|` 表示必须在所列各项中选择一个,括号为范围标记,可省略
用例:对于`.namednd (精灵|矮人|兽人) [数量]`
用法1:`.namednd 精灵`
用法2:`.namednd 矮人`
用法2:`.namednd 兽人`
错误用法:`.namednd`
错误用法2:`.namednd 牛头人`

:::

Expand Down

0 comments on commit 92363e6

Please sign in to comment.