Skip to content

代码规范

命名

变量

  1. 数值后缀使用 Value,xxxValue
  2. 字符后缀使用 Str,xxxStr
  3. 数组后缀使用 List,xxxList
  4. 对象后缀使用 Data,xxxData
  5. 布尔表示开关后缀使用 Switch,xxxSwitch
  6. 布尔表示有无前缀使用 is,isXxxx

TIP

一些常见的单词已经具有可读性即可不遵循以上命名方式,例如 color、name、title、text、label....

js
let modeValue = 0;
let contentStr = "内容";
let logList = [{ time: 1764124998000, value: 0 }];
let userData = { name: "黎明花", age: 18, hobby: "唱跳rap" };
let powerSwitch = false;
let isFlag = false;
let modeValue = 0;
let contentStr = "内容";
let logList = [{ time: 1764124998000, value: 0 }];
let userData = { name: "黎明花", age: 18, hobby: "唱跳rap" };
let powerSwitch = false;
let isFlag = false;

常量

  1. 使用以上变量方式命名,字母全大写下划线分割,XXX_VALUE
  2. 映射关系使用首字母大写后缀使用 Map,XxxMap
js
const PRIMARY_COLOR = "#FFFFFF";
const ModeTextMap = { 1: "低", 2: "中", 3: "高" };
const PRIMARY_COLOR = "#FFFFFF";
const ModeTextMap = { 1: "低", 2: "中", 3: "高" };

方法

  1. 事件处理时前缀使用 handle,handleXxx()
  2. 渲染 UI 时前缀使用 render,renderXxx()
  3. 仅内部使用时,前缀使用_,_xxx(),例如工具函数、渲染函数
js
// Event
handlePowerSwitch() {}
// Render
_renderModeCard() {}
// Utils
_formatterLabel() {}
// Event
handlePowerSwitch() {}
// Render
_renderModeCard() {}
// Utils
_formatterLabel() {}