ReactNative代码规范

208 阅读1分钟

在写代码和阅读别人代码时,学到的代码规范,记录一下。

1、意义

  1. 一般公司代码都是多人维护的。当写一套不规范且容易让人产生误解的代码时,其他人在开发时或者自己再次开发时的调研难度就会比较大,效率较低,且出现问题的概率也较大。
  2. 好的代码通过文件名、类名、方法名、变量名等就能迅速了解含义,且不容易让人产生误解。如果一个人直观上没看懂这段代码就说明应该加注释了;好的代码结构清晰,开发者很容易找到需要开发的点。
  3. 高内聚低耦合的代码有利于长期维护。高内聚指方法功能单一;低耦合指代码逻辑和结构要尽量解耦,不要相互关联性太强,牵一发而动全身。

2、命名规范

  1. 目录使用大驼峰,入口文件以index命名;
  2. 文件名使用大驼峰,且与其类命名对应;
  3. 静态变量、枚举全大写,以下划线分割;
  4. 局部变量、全局变量使用小驼峰。

3、注释

  1. /** xxx */ 类、方法注释;
  2. /* xxx */ 方法内多行注释;
  3. // xxx 单行注释。

4、其他

  1. private、protect、public本着最小访问权限原则;
  2. 方法命名可以根据以点击方法、get/set方法等划分,以onPressXXX、getXXX、setXXX命名;
  3. 命名中使用的英文没必须简写的就全写,公认的简写如Btn等可以;
  4. 待补充。