JavaScript 开发规范

一、外部规范——包结构划分

 

注意事项：

1.      文件机构划分：

a)        目录结构和后台保持一致，如上图1。

b)        同一模块下的文件放同一个目录之中，如上图1。

c)        如果模块功能较多且实现代码比较复杂，建议进行文件切分，在切分过程中也要按照与后台一致的包结构进行划分，如上图2。

 

 

二、内部规范——函数规范

A  定义命名空间（在文件名称的基础上进行包结构划分）

B  定义函数

注意事项：书写空间下的方法,命名规则需达到如下要求

1.       函数名要有意义并且通过函数名要能返回如下信息：是否有返回值、业务、返回类型

2.       建议为首单词要明确函数是否有返回值有则用get没有则不写                                    

3.       第二个单词要表明业务意图如CRUD或其他业务

4.       第三个单词要表明当前函数最终返回的类型如ext开发一般有 win panel component等js开发一般有 object function array 等类型。

 

C 函数参数

注意事项：

1.       参数名称有意义，不要使用单个字母作为参数。

2.       参数类型如布尔必须is开头数字数组对象分别以 Number Arr Obj结尾。

3.       参数尽量与后台实体类对应（特殊情况除外）。

4.       如果定义函数可能会被他人调用，在参数个数不明确的情况下尽量保证函数的参数在五个之内(特殊情况除外)，即最后一个参数必须为对象类型，如果将来参数增加则将新增参数放于最后一个对象参数当中去，如果参数个数减少，调用者以null补位。

 

D 定义变量（公共函数或组件的封装）

注意事项：

1.       变量名要有意义，做到见名知意。

2.       变量作用于要适当，避免产生过多的全局变量。

3.       定义全局变量要使用大写，局部变量使用小写。

4.       变量名切勿与js或 js类库的关键字相似或类同。

 

 

E 函数继承及封装（公共函数或组件的封装）

注意事项：

1.  封装函数的易用性(使用者调用方便)，以及后期维护重构的灵活性。（切勿写死）。

2.  封装函数是否具有扩展性。（在此基础上是否可以提升功能和性能）。

3.  封装函数的内部细节代码的实现是否需要使用者在调用的代码中处理（函数功能要全面和完善）。

4.  封装函数的功能是否可以一步到位（如果用户调用封装函数，只是利用其中的部分功能，剩余功能还需要依赖于自己的代码实现，建议不进行封装）。

5.       封装函数是否可以实现重复使用。（如果只是针对某一功能而封装一个函数，后期不再复用，建议不用封装）。

 

 

 

 

三、Ext开发注意细则

1.遵循JavaScript开发规范。

2.按照相关业务关系，代码顺序按照从上到下的次序进行定义，基本组件定义在前，最大容器定义在最后。

3.适度定义变量，如果ext相关配置属性为静态配置，尽量定义在父容器或组件之中，方便日后查找和维护，如果为动态配置属性，则写在父容器之前或父容器之中，切勿写在父容器之后。

4.布局的使用要合理，确保在不同分辨率下不会出现布局紊乱。

5.在数据交互的过程中，要充分考虑请求异常或失败时发生的特殊情况，并做好相应的处理，做到即使出现交互失败，界面任然不会出现卡死或持续请求等状况。

6.分清楚ext中属性，方法，事件，配置项的区别。