From 2cb33c307ff1fdc5002f27f23234f1a63698909f Mon Sep 17 00:00:00 2001 From: richie Date: Tue, 24 Sep 2019 11:38:09 +0800 Subject: [PATCH] =?UTF-8?q?=E5=91=BD=E5=90=8D=E8=A7=84=E8=8C=83?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/name.md | 5 +++++ readme.md | 4 ++++ 2 files changed, 9 insertions(+) create mode 100644 docs/name.md diff --git a/docs/name.md b/docs/name.md new file mode 100644 index 0000000..60e1a3a --- /dev/null +++ b/docs/name.md @@ -0,0 +1,5 @@ +# 命名规范 + +* 在产品内部,接口会有一个抽象类实现,命名方式为Abstract+接口名,而在SDK中推荐使用Base+接口名来命名开放给插件使用的抽象类。 + +* 在产品内部,工具类工厂是以+Utils或者+Helper结尾的,而在SDK中推荐使用+Kit的方式作为类名的结尾。 diff --git a/readme.md b/readme.md index c128af5..1c1d596 100644 --- a/readme.md +++ b/readme.md @@ -32,6 +32,10 @@ SessionKit#getSession(@NotNull String sessionID); 开放类列表见:[非FineKit开放类](docs/claim.md) +## 约定俗成的规范 + +见:[命名规范](docs/name.md) + ## 使用方法 先使用maven打包,执行下面的命令(跳过单元测试)