Browse Source

命名规范

pull/1/head
richie 5 years ago
parent
commit
35ca5c3868
  1. 12
      docs/name.md
  2. 2
      readme.md

12
docs/name.md

@ -1,5 +1,13 @@
# 命名规范 # 命名和设计规范
* 在产品内部,接口会有一个抽象类实现,命名方式为Abstract+接口名,而在SDK中推荐使用Base+接口名来命名开放给插件使用的抽象类。 * 在产品内部,接口会有一个抽象类实现,命名方式为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,包括但不限于:用户管理、登入登出、权限管理、模板管理等。

2
readme.md

@ -34,7 +34,7 @@ SessionKit#getSession(@NotNull String sessionID);
## 约定俗成的规范 ## 约定俗成的规范
见:[命名规范](docs/name.md) [命名和设计规范](docs/name.md)
## 使用方法 ## 使用方法

Loading…
Cancel
Save