方法规范
方法规范文档。
info命名规范:
- 命名原则:
- 使用驼峰命名;
- 必须包含明确含义,编码使用全英文单词,禁止使用汉语拼音及简拼。
- 方法编码:
直接按功能get、update、save、delete、select、open...开头+业务信息,无需加下划线,使用驼峰命名
。- 方法名称:
功能修饰
。- 应用范围:服务端方法、客户端方法。
示例:
自定义方法 | 命名方式 | 例子1 | 例子2 | 例子3 |
---|---|---|---|---|
方法编码 | get、update、save、delete、select、open...开头+业务信息 | getUserInfo | openUserEdit | deleteUserInfo |
方法名称 | 功能修饰 | 获取用户信息 | 打开用户编辑窗体 | 删除用户信息 |
命名规范:
- 命名原则:
- 使用驼峰命名;
- 必须包含明确含义,编码使用全英文单词,禁止使用汉语拼音及简拼。
- 方法编码:
对应前缀_功能修饰
。
- SPI前缀:
spi_
。- EP前缀:
ep_
。- 方法名称:
功能修饰
。示例:
SPI/EP方法 | 命名方式 | SPI例子 | EP例子 |
---|---|---|---|
SPI/EP方法编码 | 对应前缀_功能修饰 | spi_getData | ep_getData |
SPI/EP方法名称 | 功能修饰 | 获取数据 | 获取数据 |
命名规范:
- 命名原则:
- 使用驼峰命名;
- 必须包含明确含义,编码使用全英文单词,禁止使用汉语拼音及简拼;
- 业务动作扩展点实现命名保留默认。
- 方法编码:
action_功能修饰
。- 方法名称:
功能修饰
。示例:
业务动作 | 命名方式 | 例子1 | 例子2 | 例子3 |
---|---|---|---|---|
业务动作方法编码 | action_功能修饰 | action_save | action_submit | action_print |
业务动作扩展点编码 | ep_action_功能修饰 | ep_action_save | ep_action_submit | ep_action_print |
方法名称 | 功能修饰 | 保存 | 提交 | 打印 |
info规则名称必须加上必要注释或者规则说明,规则编码一般不做要求。命名要求如下:
- 在新增规则时,规则加上
“【”
+ 功能修饰+“】 ”
。- ”执行方法“规则保留默认,无需修改。
示例:
规则 | 命名方式 | 例子1 | 例子2 |
---|---|---|---|
规则名称 | 规则名称【功能修饰】 | 中断规则【入参为空则中断当前】 | 修改数据库中的记录【报销申请主表】 |
info在编写方法(函数)实现功能时遵循以下规则:
- 尽量降低配置方法间的藕合度、以便修改和扩展。
- 事件中调用相应的窗体、控件方法时不要在窗体、控件方法中配置相应的规则或函数,建议只调用实现相关功能的自定义方法。
- 每个方法(函数)配置的规则不要过多(不建议超过10个)。
- 如果实现的功能过于复杂,需要在方法配置过多规则时,把规则拆分封装到相应的方法进行调用。