Add config doc for rawstr4c

This commit is contained in:
Aoran Zeng 2025-07-12 19:26:04 +08:00
parent aa2fd3381d
commit 5b681e2a68
No known key found for this signature in database
GPG Key ID: 8F8BA8488E10ED98

View File

@ -1,5 +1,52 @@
<!-- -----------------------------------------------------------
! SPDX-License-Identifier: GFDL-1.3-or-later
! -------------------------------------------------------------
! Doc Type : Markdown
! Doc Name : (rawstr4c configuration).md
! Doc Authors : Aoran Zeng <ccmywish@qq.com>
! Contributors : Nul None <nul@none.org>
! |
! Created On : <2025-07-12>
! Last Modified : <2025-07-12>
! ---------------------------------------------------------- -->
# rawstr4c
## 配置语法
```markdown
- config-name = `value`
- config-name2 = `:mode`
```
配置项总是以 `-` 开头,配置项名称后跟一个 `=`,右值必须使用 ``` `` ``` 来包裹
注意,如果值并非是由用户随意给出,而是只能是默认的几种值之一,则使用 `:` 作为前缀
<br>
## 配置选项
- translate = `:hex` | `:oct` | `:escape`
- postfix =
- `:use-language`: 使用 code block 的语言
- `scratch string`: 使用某一自定义字符串为后缀
- name =
生成的变量名,默认将会包含前缀和后缀
- keep-prefix =
变量名是否使用前缀
- keep-postfix =
变量名是否使用后缀