# Xslx2CfgCode

**Repository Path**: linrealp/xslx2-cfg-code

## Basic Information

- **Project Name**: Xslx2CfgCode
- **Description**: Excel配置表转EchoFramework配置代码工具(已转Luban)
- **Primary Language**: C#
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2023-03-24
- **Last Updated**: 2023-10-08

## Categories & Tags

**Categories**: Uncategorized

**Tags**: Csharp

## README

# Xslx2CfgCode

Excel配置表转**EchoFramework**配置代码工具(已转Luban)，采用C#编写，引用NPOI库。该工具仅是一个C#控制台程序。

![生成示例](https://blog-1258865037.cos.ap-chengdu.myqcloud.com/Xslx2CfgCode%2FSnipaste_2023-03-24_16-28-42.png)

仓库地址：https://gitee.com/linrealp/xslx2-cfg-code



## 前置条件

- `.Net`环境



## 基础介绍

1. 该工具会识别后缀名为`.xlsx`的文件，读取符合名称格式的`sheet`表，不符合名称格式的`sheet`表会被忽略，一个`.xlsx`中可以包含多个符合格式的表，均可生成`xml`文件。名称格式为：`xxx|yyy`，例如：`示例表|Example`

2.  `Excel`文件中前4行被固定使用：
    
    - 第一行表示字段需要的端(`s`表示服务端`server`，`c`表示客户端`client`)
    - 第二行表示字段类型
    - 第三行表示字段名
    - 第四行表示注释
    
3. 配置生成使用批处理的方式，批处理有中须填入**2**个参数

   - 参数1：模板文件路径
   - 参数2："1"使用Excel表标识为客户端的字段  "2"使用Excel表标识为服务器的字段

   ```bash
   //批处理文件格式
   dotnet Xslx2CfgCode.dll 参数1 参数2
   pause
   
   //客户端表全部生成批处理示例
   dotnet Xslx2CfgCode.dll Templates/EchoCfgFieldTemplate.txt 1
   pause
   ```
   
4. **Templates**文件夹放置模板代码

   - `_CLASSCOMMENT` : 类注释
   - `_CLASSNAME`: 类名
   - `_FIELDCODE`: 字段声明



## 如何使用

1. 双击打开需要的批处理文件
2. 按照提示拖入Excel文件
3. 输入选项，选择要依据的配置表，若直接回车，则默认选中第一个
4. 生成代码会复制到系统剪贴板