naming.md 991 B

业界目前广泛采用的两种命名规则:

  1. 单词大写开头。 驼峰 (PascalCase)
  2. 单词横线连接 (kebab-case)。

这里我们根据历史项目的评估,针对文件名选用第二种规则 (kebab-case)。

项目命名

全部采用小写方式, 以下划线分隔。

例:my_project_name

目录命名

参照项目命名规则;

有复数结构时,要采用复数命名法。

例:scripts, styles, images, data_models

JS文件命名

参照项目命名规则。

采用 (业务/功能)_模块 形式命名资源目录及资源。

例:account_model.js

CSS, SCSS文件命名

参照JS命名规则。

例:retina_sprites.scss

HTML文件命名

参照JS命名规则。

例:error_report.html

VUE文件命名

参照JS命名规则。

例:error_report.vue

示例

<!-- HTML -->

order_list.html
order_detail.html

<!-- CSS / SCSS -->

order_list.css
order_detail.scss

<!-- JS / TS -->

order_list.js
order_detail.ts