开发规范

版权声明

• 文章作者: flytreeleft - flytreeleft@crazydan.org
• 文章链接: https://duzhou.crazydan.io/docs/development/specification
• 版权声明: 本文章采用许可协议《署名 4.0 国际 (CC BY 4.0)》。 转载或商用请注明来自渡舟平台！

命名规范

• 专有名词保持全部小写，或者，首字母大写，其余字母小写
• Xpl 函数采用驼峰命名形式，且首字母大写。内部或私有函数以 _ 开头
• 用于前端显示用的对象名称属性，命名为 displayName； 在代码层面使用的名称属性，命名为 name 或 code； 描述、说明和备注命名为 description

用户交互

• 涉及多级定位的页面或元素，需明确显示其层级路径， 以清晰展示其所处位置，并可自由跳转回前面的任意位置
• 常用的功能按钮需直接展示出来，尽可能减少触发的深度， 确保其可以直接触发，但整体布局仍需优先保证视觉上的简洁性
• 功能图标优先添加辅助文字，在空间不足时提供浮动提示
• 对于关联数据提供查看详细信息的机制，可以直接跳转到详细信息查看窗口或页面
• 对于数据删除需提供撤销或还原机制，避免物理删除
• 对于各种表单项、枚举值等，均需要在显著位置提供备注说明， 确保填写和选择时，能够让用户做出准确的判断和决策
• 在绑定关联时，若关联数据不存在，则在用户有新增权限时， 应提供对关联的新增操作入口