Skip to content

命名规约

说明

常见的几种命名规则:

  1. camelCase(驼峰式),举例firstName
  2. kebab-case(短横线),举例first-mame
  3. PascalCase(首字母大写),举例FirstName

1. 项目命名

项目命名全部采用kebab-case(短横线)方式。

正例:mall-manage-system
反例:mall_manage_system、mallManageSystem

2. 目录命名

全部采用kebab-case(短横线)方式,有复数结构时,要采用复数命名法, 缩写不用复数。

正例:scripts/styles/components/images/utils/layouts/doc
反例:script/style/component/image/util/layout/docs

3. 文件命名

全部采用kebab-case(短横线)方式。

正例:home-page.html
反例:homePage.html

4. 命名严谨性

代码中的命名严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式。 说明:正确的英文拼写和语法可以让阅读者易于理解,避免歧义。注意,即使纯拼音命名方式也要避免采用. 杜绝完全不规范的缩写,避免望文不知义:如abstract-class不能缩写为abs-classabs-cls