代码规范

一. 目标

1.安全：代码完成所需的功能之余,不要产生负作用,即要稳定可靠.

2. 易读：类,实例,成员变量,成员函数的命名一目了然

3. 美观：尽量统一项目组内人员的编程风格,保证一致性,统一性.

二.具体注意事项.

1. 类中的代码需要按功能分块，分为类内部变量，类属性，类事件，类初始化，类方法，如果没有则无需添加该分类
2. 类内部变量写法为以下划线开头，首字母大写
3. 类属性写法为与类内部变量同名，不用下划线开始
4. 与初始化相关的函数都写在初始化块中
5. 类方法中如果函数多，需要再次分块
6. 原则上每个类不应该超过500行
7. 原则上每个函数不应该超过50行
8. 每行代码不应该超过75列
9. 类方法的命名需要以动词开头，以有意义的，可查询的动词词组表示，以Google翻译为基础
10. 遵循单函数单功能原则
11. 如果两个类有相互调用情况，使用事件注册机制，不要使用相互传递对象的方法
12. 构造函数不要添加大计算量过程
13. 清理警告内容，包括不需要的函数，不正确不清晰的注释
14. 文件名的命名必须和其中的类一致，单类单文件，每个文件代码量不应该超过600行
15. SQL脚本开发时，所有的关键字全部使用大写，其他可以采购大小写混写
16. 获取环境变量时，不能使用Environment对象中的路径，该路径会随着文件选择的变化而变化
17. 文件头部应有注释，简单描述文件的内容
18. 对于程序中的比较关键的算法和函数，必须加注释