Skip to content

Commit 80c9db5

Browse files
committed
Update doc
1 parent a813429 commit 80c9db5

File tree

1 file changed

+13
-9
lines changed

1 file changed

+13
-9
lines changed

tool/rawstr4c/README.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
! Contributors : Nul None <[email protected]>
88
! |
99
! Created On : <2025-07-12>
10-
! Last Modified : <2025-07-14>
10+
! Last Modified : <2025-07-16>
1111
! ---------------------------------------------------------- -->
1212

1313
# rawstr4c
@@ -33,10 +33,10 @@ just rawstr4c ./src/recipe/ware
3333

3434
- section 标题
3535
- 对该变量的说明
36-
- 配置项
37-
- 配置项注释
38-
- code block (raw string)
39-
- 对 code block 内容的注释
36+
- 配置块 configblock
37+
- 配置块 configblock 注释
38+
- 代码块 codeblock (raw string)
39+
- 代码块 codeblock 内容的注释
4040

4141
<br>
4242

@@ -56,7 +56,7 @@ just rawstr4c ./src/recipe/ware
5656

5757
配置项总是以 `-` 开头,配置项名称后跟一个 `=`,右值必须使用 ``` `` ``` 来包裹
5858

59-
注意,如果值并非是由用户随意给出,而是只能是默认的几种值之一,则使用 `:` 作为前缀
59+
注意,如果值并非是由用户随意给出,则应该设置为 mode 类型,使用 `:` 作为前缀
6060

6161
<br>
6262

@@ -73,7 +73,7 @@ just rawstr4c ./src/recipe/ware
7373
- `:global-variable` = 输出一个 `.h` 文件和对应的 `.c` 文件,定义为全局变量
7474
- `:global-variable-only-header` = 仅输出为一个 `.h` 文件,定义为全局变量
7575

76-
- output-file =
76+
- ~~output-file~~ = (暂未实现)
7777

7878
自定义生成的头文件名,默认值为 `rawstr4c.h`
7979

@@ -85,8 +85,8 @@ just rawstr4c ./src/recipe/ware
8585

8686
- postfix =
8787

88-
- `:use-language` = 使用 code block 的语言
89-
- `scratch string` = 使用某一自定义字符串为后缀
88+
- `:use-language` = 使用 codeblock 的语言
89+
- `your string` = 使用某一自定义字符串为后缀
9090

9191
- name =
9292

@@ -96,6 +96,10 @@ just rawstr4c ./src/recipe/ware
9696

9797
无视其他配置项,直接使用 `name` 作为变量名
9898

99+
- namespace =
100+
101+
将作为变量名 `name` 之前 `prefix` 之后的前缀,将影响下一层级的 section
102+
99103
- keep-prefix = `true` | `false`
100104

101105
变量名是否使用前缀

0 commit comments

Comments
 (0)