docs(0): [java]-[wcferry-mvn]-说明文件修改
This commit is contained in:
parent
b67e824cc8
commit
a486816f02
61
clients/java/wcferry-mvn/README.MD
vendored
61
clients/java/wcferry-mvn/README.MD
vendored
@ -66,5 +66,66 @@ wcferry:
|
||||
| jna | 5.6.0 | 态访问系统本地库 |
|
||||
| nng-java | 1.4.0 | 本地包 |
|
||||
|
||||
### 模块结构
|
||||
|
||||
```
|
||||
wcferry-mvn
|
||||
├─dll 核心dll
|
||||
│ ├─sdk.dll sdk文件
|
||||
│ └─readme.txt 本目录说明文件
|
||||
│
|
||||
├─src 源
|
||||
│ ├─main 重启命令
|
||||
│ │ ├─java(com.iamteer) java代码目录
|
||||
│ │ │ ├─config 配置
|
||||
│ │ │ ├─entity 实体
|
||||
│ │ │ ├─runner 运行(程序启动中与启动后的自动化任务都放置于此)
|
||||
│ │ │ ├─service 业务接口
|
||||
│ │ │ │ └─impl 业务实现类
|
||||
│ │ │ ├─Client.java socket客户端
|
||||
│ │ │ └─WcferryApplication.java 启动类
|
||||
│ │ │resources 数据库脚本
|
||||
│ │ │ ├─libs 本程序内置依赖包
|
||||
│ │ │ ├─win32-x86-64 依赖程序
|
||||
│ │ │ ├─application.yml 本程序主配置文件
|
||||
│ │ │ └─logback-spring.xml 日志配置文件
|
||||
│
|
||||
├─pom.xml POM文件
|
||||
├─README.MD 说明文件
|
||||
│
|
||||
|
||||
```
|
||||
|
||||
### 配置说明
|
||||
|
||||
本程序主配置文件为 application.yml
|
||||
|
||||
#### 配置参数
|
||||
|
||||
本程序内置参数统一前缀:wcferry 所有自定义本服务的参数请都放置在此前缀下,如:
|
||||
|
||||
```ymal
|
||||
wcferry:
|
||||
# DLL文件位置
|
||||
dll-path: /dll/sdk.dll
|
||||
```
|
||||
|
||||
### 提交规范
|
||||
|
||||
本模块希望大家使用统一提交格式,便于区分
|
||||
|
||||
格式:类型(任务号/缺陷号/没有使用0替代): [模块名称]-[子模块名称]-本次修改的说明
|
||||
|
||||
如:
|
||||
|
||||
```cmd
|
||||
feat(0): [java]-[wcferry-mvn]-基础类目录划分迁移及代码格式
|
||||
```
|
||||
|
||||
| 名称 | 版本 |
|
||||
|------|--------------|
|
||||
| feat | 新功能 |
|
||||
| fix | 缺陷 |
|
||||
| ... | 其他等git规范中的均可 |
|
||||
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user