基本技能 -- 命名规范

661 阅读1分钟

前言

编程时遵守命名规范会有利于后期维护和团队协作,这是必备技能,也是该遵守的规则

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

实际上并没有说具体什么地方必须要用哪个命名规范,个人开发就按照个人习惯,团队协作开发就按照团队约定好的规范即可,我这里只是列举而已,命名规范用在什么地方因人而异。

命名规范

驼峰命名法(lowerCamelCase)

常用于 成员变量、局部变量名、函数名、文件名,由其意义翻译成英文,然后各个单词组合起来,除了首个单词以外剩余单词首字母大写

mainTitleFontSize: 16 // 成员变量、局部变量名
mainTitleFontSizeChange(){} // 函数名
basicInfodrawer.vue // 文件名

串式命名法(kebab-case)

常用于 类名、文件夹名,各个单词之间通过-组合起来

.chart-icon { /* 类名 */
  padding: 5px;
  font-size: 20px;
  cursor: pointer;
  border: 1.5px solid gray;
}

再比如 dubbo 项目的各个模块文件夹的命名是这样的:

image.png

另外,vue 组件的引入通常是这样命名的:

<template>
  <my-component-name></my-component-name> <!--串式命名法-->
</template>

<script>
import MyComponentName from './MyComponentName.vue' // 大驼峰命名法
export default {
  components: {
      MyComponentName, // 大驼峰命名法
  },
};
</script>

<style lang="less" scoped></style>

蛇形命名法(snake_case)

常用于 常量名称、枚举名称,各个单词之间通过下划线_组合起来

// 常量
MAX_LENGTH
LAST_DATA
// 枚举名称
first_name
last_name