Beta阶段置顶集合随笔

一. 代码规范&团队GitHub仓库

代码中的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束。
代码中的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。
类名使用 UpperCamelCase 风格，必须遵从驼峰形式，但以下情形例外：DO / BO /
DTO / VO / AO
方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格，必须遵从
驼峰形式
中括号是数组类型的一部分，数组定义如下：String[] args;
如果模块、接口、类、方法使用了设计模式，在命名时体现出具体模式。
左小括号和字符之间不出现空格；同样，右小括号和字符之间也不出现空格。
if/for/while/switch/do 等保留字与括号之间都必须加空格。
任何二目、三目运算符的左右两边都需要加一个空格。
单行字符数限制不超过 120 个，超出需要换行，换行时遵循如下原则：
1）第二行相对第一行缩进 4 个空格，从第三行开始，不再继续缩进，参考示例。
2）运算符与下文一起换行。
3）方法调用的点符号与下文一起换行。
4）方法调用时，多个参数，需要换行时，在逗号后进行。
方法参数在定义和传入时，多个参数逗号后边必须加空格。

项目代码的规范采用的是eslint作为代码检测工具

// good
function test() {
∙∙let name;
}

let firstName = 'whh';

// bad
function a() {
  // ...
}

函数采用小驼峰命名

// bad
const this_object = {};
// good
const thisObject = {};
function thisIsFunction() {}

类采用大驼峰命名

class User {
  constructor() {
    ...
  }
}

const xxx = require('xxx');

let name = xxx;

类当中的方法要空一行

let a = b + c;

//bad
let name = "xxx";
//good
let name = 'xxx';

函数调用，if语句等的{}与() 要有空格。

if (xx) {

}

posted @ 2021-06-08 14:12 菜购阅读(103) 评论(0) 编辑收藏举报