应用构建编码规范

1、应用构建编码规范

1.1、应用创建规范

应用所属领域和应用业务能力保持一致

1.2、命名规范

1.2.1、实体字段命名

• 原厂扩展业务属性加前缀extend,如：extendMerchantCode**

以下关键字禁用

base    id    tenant_id    creator    createTime modifier    modifyTime    pubts    dr    pk_temp version    approvalFlow    pk_procdefins    pk_procdef    startorg startdept    verifystate    isWfControlled    businessFlow    bizFlowId isFlowCoreBill    bizFlowName    bizFlowVersion    source_id    sourcechild_id source_billtype    bizFlowInstanceId    businessType    bustype    ITree parent    level    path    sort    isEnd name    code    enable    enablets    disablets org_id     status

2.2.2、页面建模

节点发布避免出现【**列表】，请调整列表页面命名

1.2.3、函数

1.2.3.1、驼峰式命名规范

驼峰式命名法介绍：

驼峰式命名法由小(大)写字母开始，后续每个单词首字母都大写。

按照第一个字母是否大写，分为：

 ① Pascal Case 大驼峰式命名法：首字母大写。eg：StudentInfo、UserInfo、ProductInfo ② Camel Case 小驼峰式命名法：首字母小写。eg：studentInfo、userInfo、productInfo

1.2.3.2、变量

命名方法：小驼峰式命名法。

命名规范：前缀应当是名词。(函数的名字前缀为动词，以此区分变量和函数)

命名建议：尽量在变量名字中体现所属类型，如:length、count等表示数字类型；而包含name、title表示为字符串类型。

// 好的命名方式 var maxCount = 10; var tableTitle = 'LoginTable'; // 不好的命名方式 var setCount = 10; var getTitle = 'LoginTable';

1.2.3.3、函数

命名方法：小驼峰式命名法。

命名规范：前缀应当为动词。

命名建议：可使用常见动词约定

// 是否可阅读 function canRead() { return true; } // 获取名称 function getName() { return this.name; }

1.2.3.4、常量

命名方法：名称全部大写。

命名规范：使用大写字母和下划线来组合命名，下划线用以分割单词。

命名建议：无。

示例：

var MAX_COUNT = 10; var URL = 'http://www.baidu.com';

1.2.3.5、单行注释

说明：单行注释以两个斜线开始，以行尾结束。

语法：// 这是单行注释

使用方式：

  ① 单独一行：//(双斜线)与注释文字之间保留一个空格。  ② 在代码后面添加注释：//(双斜线)与代码之间保留一个空格，并且//(双斜线)与注释文字之间保留一个空格。  ③ 注释代码：//(双斜线)与代码之间保留一个空格。

示例：

// 调用了一个函数；1)单独在一行 setTitle(); var maxCount = 10;