Browse Source

命名规范

master
richie 5 years ago
parent
commit
2cb33c307f
  1. 5
      docs/name.md
  2. 4
      readme.md

5
docs/name.md

@ -0,0 +1,5 @@
# 命名规范
* 在产品内部,接口会有一个抽象类实现,命名方式为Abstract+接口名,而在SDK中推荐使用Base+接口名来命名开放给插件使用的抽象类。
* 在产品内部,工具类工厂是以+Utils或者+Helper结尾的,而在SDK中推荐使用+Kit的方式作为类名的结尾。

4
readme.md

@ -32,6 +32,10 @@ SessionKit#getSession(@NotNull String sessionID);
开放类列表见:[非FineKit开放类](docs/claim.md) 开放类列表见:[非FineKit开放类](docs/claim.md)
## 约定俗成的规范
见:[命名规范](docs/name.md)
## 使用方法 ## 使用方法
先使用maven打包,执行下面的命令(跳过单元测试) 先使用maven打包,执行下面的命令(跳过单元测试)

Loading…
Cancel
Save