代码规范

一、类名、枚举名、命名空间名采用UpperCamelCase风格

类采用首字母大写的驼峰命名法;类名通常是名词或名词短语,例如Person、Student、Worker。不应使用动词

二、变量名、方法名、参数名采用lowerCamelCase风格

函数的命名通常是动词或动词短语,采用小驼峰命名。示例如下:

load + 属性名()

put + 属性名()

is + 布尔属性名()

has + 名词/形容词()

动词()

动词 + 宾语()

变量名通常是名词或名词短语,采用小驼峰命名,便于理解。

三、常量名、枚举值名采用全部大写,单词间使用下划线隔开

常量命名,应该由全大写单词与下划线组成,单词间用下划线分割。常量命名要尽量表达完整的语义。

const MAX_USER_SIZE = 10000;

enum UserType {

  TEACHER = 0,

  STUDENT = 1

};

四、避免使用否定的布尔变量名,布尔型的局部变量或方法需加上表达是非意义的前缀

布尔型的局部变量建议加上表达是非意义的前缀,比如is,也可以是has、can、should等。但是,当使用逻辑非运算符,并出现双重否定时,会出现理解问题,比如!isNotError,难以理解。因此,应避免定义否定的布尔变量名。

let isError = false;

let isFound = true;

function isEmpty() {}

function hasNext() {}

五、格式

1、使用空格缩进,禁止使用tab字符

只允许使用空格(space)进行缩进。

建议大部分场景优先使用2个空格,换行导致的缩进优先使用4个空格。

不允许插入制表符Tab。当前几乎所有的集成开发环境(IDE)和代码编辑器都支持配置将Tab键自动扩展为2个空格输入,应在代码编辑器中配置使用空格进行缩进。

2、行宽不超过120个字符

3、条件语句和循环语句的实现建议使用大括号

4、switch语句的case和default需缩进一层

switch的case和default要缩进一层(2个空格)。开关标签之后换行的语句,需再缩进一层(2个空格)。

5、表达式换行需保持一致性,运算符放行末

6、多个变量定义和赋值语句不允许写在一行

7、空格应该突出关键字和重要信息,避免不必要的空格

空格应该突出关键字和重要信息。总体建议如下:

(1)、if, for, while, switch等关键字与左括号(之间加空格。

(2)、在函数定义和调用时,函数名称与参数列表的左括号(之间不加空格。

(3)、关键字else或catch与其之前的大括号}之间加空格。

(4)、任何打开大括号({)之前加空格,有两个例外:

            a) 在作为函数的第一个参数或数组中的第一个元素时,对象之前不用加空格,例如:foo({ name: 'abc' })。

            b) 在模板中,不用加空格,例如:abc${name}。

(5)、二元操作符(+ - * = < > <= >= === !== && ||)前后加空格;三元操作符(? :)符号两侧均加空格。

(6)、数组初始化中的逗号和函数中多个参数之间的逗号后加空格。

(7)、在逗号(,)或分号(;)之前不加空格。

(8)、数组的中括号([])内侧不要加空格。

(9)、不要出现多个连续空格。在某行中,多个空格若不是用来作缩进的,通常是个错误。

8、建议字符串使用单引号(在TypeScript、ArkTS适用,iOS使用双引号)

9、对象字面量属性超过4个,需要都换行

对象字面量的属性应保持一致的格式:要么每个属性都换行,要么所有属性都在同一行。当对象字面量的属性超过4个时,建议统一换行。

interface I {

    name: string

    age: number

    value: number

    sum: number

    foo: boolean

    bar: boolean

}

let obj: I = {

   name: 'tom',

   age: 16,

   value: 1,

   sum: 2,

   foo: true,

   bar: false

}

10、把else/catch放在if/try代码块关闭括号的同一行

编写条件语句时,建议将else放在if代码块关闭括号的同一行。同样,编写异常处理语句时,建议将catch放在try代码块关闭括号的同一行。

11、大括号{和语句在同一行

六、ArkTS编程实践

1、建议添加类属性的可访问修饰符

ArkTS提供了private, protected和public可访问修饰符。默认情况下,属性的可访问修饰符为public。选取适当的可访问修饰符可以提升代码的安全性和可读性。注意:如果类中包含private属性,无法通过对象字面量初始化该类。

class C {

  private count: number = 0

  public getCount(): number {

    return this.count

  }

}

2、不建议省略浮点数小数点前后的0

ArkTS中,浮点值包含一个小数点,不要求小数点之前或之后必须有一个数字。在小数点前面和后面都添加数字可以提高代码的可读性。

const num = 0.5;

const num = 2.0;

const num = -0.7;

3、判断变量是否为Number.NaN时必须使用Number.isNaN()方法

在ArkTS中,Number.NaN是Number类型的一个特殊值。它被用来表示非数值,这里的数值是指在IEEE浮点数算术标准中定义的双精度64位格式的值。

在ArkTS中,Number.NaN的独特之处在于它不等于任何值,包括其本身。与Number.NaN进行比较时,结果是令人困惑的:Number.NaN !== Number.NaN 和 Number.NaN != Number.NaN 的值都是 true。

因此,必须使用Number.isNaN()函数来测试一个值是否是Number.NaN。

if (Number.isNaN(foo)) {

  // ...

}

if (!Number.isNaN(foo)) {

  // ...

}

4、数组遍历优先使用Array对象方法

对于数组遍历,应该优先使用Array对象方法,如:forEach(), map(), every(), filter(), find(), findIndex(), reduce(), some()。

5、不要在控制性条件表达式中执行赋值操作

控制性条件表达式用于 if、while、for 以及 ?: 等条件判断语句中。

在控制性条件表达式中执行赋值容易导致意外行为,且降低代码的可读性。

6、在finally代码块中,不要使用return、break、continue或抛出异常,避免finally块非正常结束

在finally代码块中,直接使用return、break、continue、throw语句或调用方法时未处理异常,会导致finally代码块无法正常结束。finally代码块异常结束会影响try或catch代码块中异常的抛出,也可能影响方法的返回值。因此,必须确保finally代码块正常结束。

function foo() {

  try {

    // ...

    return 1;

  } catch (err) {

    // ...

    return 2;

  } finally {

    console.info('XXX!');

  }

}

7、避免使用ESObject

ESObject主要用于ArkTS和TS/JS的跨语言调用场景中的类型标注。在非跨语言调用场景中使用ESObject标注类型,会引入不必要的跨语言调用,导致额外的性能开销。

8、使用T[]表示数组类型

ArkTS提供了两种数组类型的表示方式:T[]和Array<T>。建议所有数组类型均使用T[]表示,以提高代码可读性。

// 统一使用T[]语法

let x: number[] = [1, 2, 3];

let y: string[] = ['a', 'b', 'c'];

©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成,浏览时请结合常识与多方信息审慎甄别。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

相关阅读更多精彩内容

友情链接更多精彩内容