Skip to content

命名规范

命名法:

1.驼峰命名法(小驼峰)

getUser

2.帕斯卡命名法(大驼峰)

GlobalHeader

3.短横线命名法

user-center

4.下划线命名法

MAX_LENGTH

文件、文件夹命名:

  • 文件夹作为路由页面时用小写字母,包含多个单词时,单词之间建议使用半角的连词线 ( - ) 分隔, 即短横线命名法,此时 vue 文件为index.vue
  • 文件夹作为vue 组件时用大写驼峰命名法
  • 文件作为vue 组件时用大写驼峰命名法
  • 文件作为use 函数时用小驼峰命名法
  • 其余文件用短横线命名法

变量命名:

命名方式 : 小驼峰式命名方法

命名规范 : 类型+对象描述的方式,如果没有明确的类型,就可以使前缀为名词

动词含义返回值
can判断是否可执行某个动作函数返回一个布尔值 true: 可执行; false: 不可执行
has判断是否含有某个值函数返回一个布尔值 true: 含有此值; false: 不含有此值
is判断是否为某个值函数返回一个布尔值 true: 为某个值; false: 不为某个值
get获取某个值函数返回一个非布尔值
set设置某个值无返回值、返回是否设置成功或者返回链式对象
ts
/** 是否可读 */
function canRead() {
  return true
}

/** 获取姓名 */
function getName() {
  return 'name'
}

常量

命名方法 : 使用大写字母和下划线来组合命名,下划线用以分割单词。

ts
const MAX_COUNT = 10
const URL = 'http://www.baidu.com'

TS 类型接口 interface 和 type

命名方法:大写驼峰

typescript
interface PersonInfo {
    /** 姓名 */
    name: string;
    /** 性别 '0':男; '1': 女; '2': 未知 */
    gender: '0' | '1' | '2';
    /** 年龄 */
    age: 25;
}

Contributors

作者:Long Mo
字数统计:449 字
阅读时长:1 分钟
Long Mo
文章作者:Long Mo
版权声明: 本博客所有文章除特别声明外,均采用 CC BY-NC-SA 4.0 许可协议。转载请注明来自 Longmo Docs