特别说明

本文档参考各大团队的书写规范进行整理，给出一套适合自己使用的书写规范。
参考内容:

  • 有赞 vant

命名

文件组件命名

文件命名统一使用横线连接(kebab-case)。

  1. // 组件文件名
  2. main.css
  3. simple-panel.js
  4. my-panel.vue

紧密耦合的组件名

父组件紧密耦合的子组件应该以父组件名作为前缀命名。

  1. // 以vue组件举例子
  2. list.vue
  3. list-item.vue
  4. list-item-display.vue
  5. list-item-button.vue

书写

中英文混合书写

中英文混合书写时，英文单词与中文需要使用空格间隔开，标点符号使用中文符号。
特殊说明

  • 使用中文标点符号的符号为，断点服务，例如：句号、逗号、顿号、感叹号、问号等
  • 当一些书写格式是需要使用英文符号时，保留英文符号，例如：注释中表单方法时，为 get() 。
  1. /**
  2.  * 方法 getString() 是用于获取特定值，不需要对该值进行赋值
  3.  */
  4. const getString = () => {
  5.   return "Text";
  6. }

空行的使用

在完整代码块与代码块之间，应该添加空行，便于阅读。

  1. // js 举例，方法与方法之间添加空行
  2. const getString = () => {
  3.   return "Text";
  4. }
  6. const getNumber = () => {
  7.     return 10;
  8. }
  1. <!-- HTML 举例 -->
  2. <div>模块一</div>
  4. <div>模块二</div>