团队协作规范

523 词

团队协作规范

注释

代码的注释不是越详细越好。实际上好的代码本身就是注释,我们要尽量规范和美化自己的代码来减少不必要的注释。若编程语言足够有表达力,就不需要注释,尽量通过代码来阐述。——《Clean Code》

命名方法

  • 小驼峰命名法(lowerCamelCase) :第一个单词以小写字母开始,第二个单词的首字母大写,例如:firstName、lastName。
  • 大驼峰命名法(CamelCase) :每一个单词的首字母都采用大写字母,例如:FirstName、LastName。
  • 匈牙利命名法(HN case) :基本原则为:变量名 = 属性 + 类型 + 对象描述。
  • 下划线命名法(snake_case):下划线命名法也叫蛇形法,全由小写字母和下划线组成,在两个单词之间用下滑线连接。例如:first_name。
  • 中划线命名法(kebab-case):中划线命名法也叫串式命名法,各个单词之间通过下划线“-”连接。例如:first-name。

文件资源命名通常使用中划线命名法(kebab-case)

JS 中的变量通常使用小驼峰方式(lowerCamelCase)

TS 中的类型通常使用大驼峰方式(CamelCase)

CSS 属性名使用中划线命名法(kebab-case)等。

留言