[]
        
(Showing Draft Content)

实用技巧:命名规范

推荐阅读

技术决策者

项目经理

高级技术人员

初级技术人员

测试人员




type=info

无规矩不成方圆。清晰、一致的命名可以帮助新加入团队的成员快速读懂现有的设计,减少重复劳动,降低维护风险。所以,请建立适合自己的命名规范,并且安排专人负责定期审查。

一、数据库相关

  • 数据库、表和字段都需采用英文命名,避免使用中文

  • 数据表推荐采用“下划线命名法”,即每个英文单词或汉字拼音均为小写,用_分割,如student_profile,jie_kuan_dan

  • 字段推荐采用“匈牙利命名法”,即先用小写字母表示数据类型,然后接首字母大写的英文单词。首个字母与数据类型的对应关系如下:

    • i:数字(含小数、整数、关联字段),如iQuantity、iRecordType

    • c:字符串,如cMemo

    • d:时间/日期,如dApproved

    • b:是否,如bEnabled

    • u:用户,如uApprovedBy

  • 在设计器中为英文字段名设置中文的【别名】可以提升开发效率,尤其是当开发者的英文水平不佳时。参考 帮助文档

二、应用相关

  • 应用名会出现在URL中,建议使用简短的英文或拼音缩写命名应用(如果用缩写,需要建立并维护缩写与全名对应的文档),避免使用中文

  • 服务端命令会出现在URL中,推荐采用“Pascal命名法”,避免使用中文,建议使用动词词组,如CreateStudentProfile

  • 单元格命名会出现在HTML中,推荐采用“Pascal命令法”,避免使用中文,建议使用名词词组,并且以Cell/Table/Button结尾,以区分单元格、表格和按钮,如CurrentStudentIDCell

  • 母版页、定时任务、流程、组件、报表、服务端通知,以及服务端命令的参数、服务端命令和命令中的变量等应用内部的元素,可使用中文

type=info

image 温馨提示

企业级低代码开发最佳实践是活字格官方面向进阶开发者推出的产品技术资源,旨在帮助对活字格基本功能有一定了解的开发者快速提升应用开发能力,保质保量做好企业级项目交付。如果您是初次接触活字格,这些内容可能会有些艰深难懂,这也是正常的。如果您有软件开发经验,推荐您学习《面向程序员的活字格入门课程》;否则,您也可以免费报名参加新手训练营直播课程或购买阅读《低代码开发实战:基于低代码平台构建企业级应用》(机械工业出版社),快速上手低代码开发。