imp: 以新的语法规则优化了指令描述，并带上了用例 #209
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Xiangze-Li
requested changes
Jun 21, 2024
Comment on lines
88
to
89
| 正常的用例：`.find 火球术` | ||
| 错误的用例：`.find <火球术>` |
There was a problem hiding this comment.
Suggested change
| 正常的用例：`.find 火球术` | |
| 错误的用例：`.find <火球术>` | |
| 正确的用例：`.find 火球术` | |
| 错误的用例：`.find <查询内容>` |
| 2. 不带有尖括号的内容是字面量，你应该原样输入这里的内容。 | ||
| 3. `[关键字]` 的括号 `[]` 表示此参数可以被省略。 | ||
| 4. `(关键字1|关键字2)` 的圆括号 `()` 搭配竖线 `|` 表示必须在所列各项中选择一个。 | ||
| 3. `<内容1|内容2>` 与`<内容>`类似，表示你可以写两种内容中的一种。 |
There was a problem hiding this comment.
Suggested change
| 3. `<内容1|内容2>` 与`<内容>`类似，表示你可以写两种内容中的一种。 | |
| 3. `<内容1|内容2>` 表示你应以所列出内容的其中一种替换此处内容。 |
There was a problem hiding this comment.
point：这种写法显然不局限于两个选项，<A|B|C> 也应被视为合法的多选一替换内容
| 用例：对于 `.log on [<日志名>]` | ||
| 这是可以的：`.log on` // 继续记录当前的日志 | ||
| 这也是可以的：`.log on 去年6月5日下午4点04开跑的团` // 继续记录指定的日志 | ||
|
|
||
| 5. `[关键字1|关键字2]` 的方括号 `[]` 搭配竖线 `|` 表示可以在所列各项中选择一个，或不选择此项。 |
There was a problem hiding this comment.
Suggested change
| 5. `[关键字1|关键字2]` 的方括号 `[]` 搭配竖线 `|` 表示可以在所列各项中选择一个，或不选择此项。 | |
| 5. `[字面量1|字面量2]` 的方括号 `[]` 搭配竖线 `|` 表示可以在所列各项中选择一个，或省略此项。 |
Comment on lines
+103
to
+106
| 用例：对于`.name [cn|en|jp]` | ||
| 用法1：`.name cn` | ||
| 用法2：`.name en` | ||
| 用法3：`.name jp` |
There was a problem hiding this comment.
Suggested change
| 用例：对于`.name [cn|en|jp]` | |
| 用法1：`.name cn` | |
| 用法2：`.name en` | |
| 用法3：`.name jp` | |
| 用例：对于`.name [cn|en|jp]` | |
| 用法1：`.name cn` | |
| 用法2：`.name en` | |
| 用法3：`.name jp` | |
| 用法4：`.name` | |
| 错误用法：`.name kr` |
| 用法2：`.name en` | ||
| 用法3：`.name jp` | ||
|
|
||
| 6. `(关键字1|关键字2)` 的竖线 `|` 表示必须在所列各项中选择一个，括号为范围标记，可省略 |
There was a problem hiding this comment.
Suggested change
| 6. `(关键字1|关键字2)` 的竖线 `|` 表示必须在所列各项中选择一个，括号为范围标记，可省略 | |
| 6. `(字面量1|字面量2)` 的圆括号 `()` 搭配竖线 `|` 表示必须在所列各项中选择一个。 |
| 用法3：`.name jp` | ||
|
|
||
| 6. `(关键字1|关键字2)` 的竖线 `|` 表示必须在所列各项中选择一个，括号为范围标记，可省略 | ||
| 用例：对于`.namednd (精灵|矮人|兽人) [数量]` |
There was a problem hiding this comment.
Suggested change
| 用例：对于`.namednd (精灵|矮人|兽人) [数量]` | |
| 用例：对于`.namednd (精灵|矮人|兽人) [<数量>]` |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.