docs: 更新使用方法说明
This commit is contained in:
48
Readme.MD
48
Readme.MD
@@ -1,3 +1,49 @@
|
|||||||
# JackCraft.Config
|
# JackCraft.Config
|
||||||
|
|
||||||
一个自己觉得怎么好用怎么写的配置文件库
|
一个自己觉得怎么好用怎么写的配置文件库
|
||||||
|
|
||||||
|
## 使用方法
|
||||||
|
|
||||||
|
### 获取配置文件
|
||||||
|
|
||||||
|
> 配置文件不存在时会自动创建一个空 Json 文件,但是若配置文件不是 Json 标准格式将会在写入和读取键值时抛出异常
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
// 标准示例: var config = new Config(new FileInfo(配置文件路径));
|
||||||
|
var config = new Config(new FileInfo("./config.json"));
|
||||||
|
```
|
||||||
|
|
||||||
|
### 读取键值
|
||||||
|
|
||||||
|
> 若键不存在则返回默认值,并且同时也会写入键值(若没有提供默认值则写入空)
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
// 标准示例: var value = config.Get<T>(键, <可选>默认值);
|
||||||
|
|
||||||
|
// {
|
||||||
|
// "114514": "1919810"
|
||||||
|
// }
|
||||||
|
var value = config.Get("114514", "1919810");
|
||||||
|
var value = config.Get<string>("114514");
|
||||||
|
|
||||||
|
// {
|
||||||
|
// "abc": {
|
||||||
|
// "def": 1234
|
||||||
|
// }
|
||||||
|
// }
|
||||||
|
var value = config.Get("abc.def", 1234);
|
||||||
|
var value = config.Get<int>("abc.def");
|
||||||
|
```
|
||||||
|
|
||||||
|
### 写入键值
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
// 标准示例: config.Set<T>(键, 值);
|
||||||
|
|
||||||
|
// {
|
||||||
|
// "114514": "1919810"
|
||||||
|
// }
|
||||||
|
config.Set("114514", "1919810");
|
||||||
|
|
||||||
|
// 其他类型与 Get<T> 同理...
|
||||||
|
```
|
||||||
|
Reference in New Issue
Block a user