diff --git a/rawstr4c/README.md b/rawstr4c/README.md index 96621fa..4e7577a 100644 --- a/rawstr4c/README.md +++ b/rawstr4c/README.md @@ -7,12 +7,12 @@ ! Contributors : Nul None ! | ! Created On : <2025-07-12> - ! Last Modified : <2025-07-12> + ! Last Modified : <2025-07-13> ! ---------------------------------------------------------- --> # rawstr4c -在你需要写一个复杂的C语言字符串的时候,请想起我... \" / \n ' \\ ` +当你需要写一个复杂的C语言字符串的时候,可使用该工具
@@ -36,39 +36,42 @@ ## 配置项 +注意,如非特殊说明,第一项为默认值 + - output = - `:terminal` = 在终端输出 - - `:global-variable` = 输出为一个 `.h` 文件,定义为全局变量 - `:macro` = 输出为一个 `.h` 文件,定义为宏 + - `:global-variable` = 输出一个 `.h` 文件和对应的 `.c` 文件,定义为全局变量 + - `:global-variable-only-header` = 仅输出为一个 `.h` 文件,定义为全局变量 - output-file = - 自定义生成的头文件名 + 自定义生成的头文件名,默认值为 `rawstr4c.h` - translate = + - `:escape` = 仅转义 - `:oct` = 八进制 - `:hex` = 十六进制 - - `:escape` = 仅转义 - postfix = - - `:use-language`: 使用 code block 的语言 - - `scratch string`: 使用某一自定义字符串为后缀 + - `:use-language` = 使用 code block 的语言 + - `scratch string` = 使用某一自定义字符串为后缀 - name = 生成的变量名,默认将会包含前缀和后缀 -- name-literally = `true` | `false` +- name-literally = `false` | `true` 无视其他配置项,直接使用 `name` 作为变量名 -- keep-prefix = +- keep-prefix = `true` | `false` 变量名是否使用前缀 -- keep-postfix = +- keep-postfix = `true` | `false` 变量名是否使用后缀