本帖最后由 Grayson.Shang 于 2024-10-25 17:14 编辑
代码和数据库开发实践指南
使用活字格提高开发效率和应用程序质量的最佳实践
代码开发语言规范
- 在开发插件，编写WebAPI或者JavaScript代码等时，代码应该使用英语编写，而注释可以使用中文编写
命名规范
- 推荐对数据库，表和字段使用英文名称。当然使用活字格开发时，使用中文的数据库，表，字段名称也可以正常使用。但是使用其他的数据库管理工具操作数据库时，中文的名称可能会导致兼容问题，所以我们建议使用英文来为数据库，表和字段命名。
- 数据表的推荐命令规则是"下划线命名规则"，其中每个英文单词都是小写的，并用下划线分隔，比如如"student_profile"、"jie_guan_dan"。
- 在设计器中为英文字段名设置别名可以提高开发效率。
- 使用有意义的名称，比如"Customer"而不是"Cstr"。
- 外键应具有"Id"后缀，比如"CustomerId"。
- 当服务端命令需要被第三方调用并且出现在URL中时，建议使用小写英文的动词短语作为名称，避免使用非英文名称。比如"create-student-profile"。
JavaScript，CSS
- 写JavaScript代码时建议添加注释。
- 使用跨浏览器的JavaScript语法。
- 避免重复的CSS样式。
- 尽可能的减少JavaScript和CSS代码。
数据库
- 避免在一张表中有数百个字段。
- 避免过大的字段，比如长度超过2000个字符的文本字段。
- 检查数据表外键的删除规则
复用性
- 使用模板命令和服务端命令重用业务逻辑(模板命令应处理纯逻辑，避免在模板命令中通过名称或者单元格位置，操作单元格或者表格)
- 使用组件对相同的ui元素进行封装和重用。
协同开发
- 每个开发人员都应该使用一个独立的账户
- 每个开发人员都应该使用相同版本的设计器和协同工程文件
- 避免多个开发人员同时处理相同的内容
- 每个开发人员应使用统一版本的插件
|
|
陕公网安备：61019002000258 |
隐私政策 |
网站地图