From 35ca5c3868d255782c83c222f83d58922502e129 Mon Sep 17 00:00:00 2001 From: richie Date: Tue, 24 Sep 2019 11:46:00 +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 | 12 ++++++++++-- readme.md | 2 +- 2 files changed, 11 insertions(+), 3 deletions(-) diff --git a/docs/name.md b/docs/name.md index 60e1a3a..24de771 100644 --- a/docs/name.md +++ b/docs/name.md @@ -1,5 +1,13 @@ -# 命名规范 +# 命名和设计规范 * 在产品内部,接口会有一个抽象类实现,命名方式为Abstract+接口名,而在SDK中推荐使用Base+接口名来命名开放给插件使用的抽象类。 -* 在产品内部,工具类工厂是以+Utils或者+Helper结尾的,而在SDK中推荐使用+Kit的方式作为类名的结尾。 +* 在产品内部,工具类工厂是以+Utils或者+Helper结尾的,而在SDK中推荐使用+Kit的方式作为工具类类名的结尾。 + +* 所有的包名字,都必须由一个个独立的小写的单词组成,务必不能混扎多单词组合、驼峰命名等。 + +* com.fanruan.api.design下均是提供给插件设计器部分使用的API。 + +* com.fanruan.api.report下均是提供给报表插件服务器部分使用的API。 + +* com.fanruan.api.decision下均是提供给插件调用的平台相关的API,包括但不限于:用户管理、登入登出、权限管理、模板管理等。 diff --git a/readme.md b/readme.md index 1c1d596..121545e 100644 --- a/readme.md +++ b/readme.md @@ -34,7 +34,7 @@ SessionKit#getSession(@NotNull String sessionID); ## 约定俗成的规范 -见:[命名规范](docs/name.md) +[命名和设计规范](docs/name.md) ## 使用方法