【HarmonyOS】代码规范参考

【HarmonyOS】代码规范参考

一、通用原则

1. 直白简单的逻辑代码比起注释来的更有意义；

2. 空格、换行相关的规范，需使用IDE自带的格式化，快捷键是 Ctrl+Alt+L ， 快速对代码进行格式化；

3. 开发者不能为了快速开发而牺牲了代码的健壮性和可理解性；

4. 新增代码要完全遵守规范；老代码不符合规范，则在有相关功能时同步修改； 避免魔鬼数字，如if(res.result == 99)，99应该用变量赋值代码，如if(res.result == MAX_COUNT)；

5. 关键字、对照值一类的数值或字符串应尽量用常量表示，最大程度降低手误导致的bug；

6. 代码编写过程中，除buid()外，其它部分代码每行必须要以分号( ; )结束。

7. 代码逻辑如果复制三次以上，需要提取共有函数，进行复用。【重要】

二、编码规范
1.命名
1.1 命名需要富有含义，尽量能达到见名知义的程度，避免无意义的命名。禁止使用系统关键字，例如： onClick，padding，position，direction等

1.2 变量名详细程度，根据变量作用范围而定，成员变量 > 大函数的局部变量 > 小函数的局部变量，作用域越大，变量名则应更详细。
例如对于一个类型的变量