Skip to content

命名规范

在为一个资源其名称的时候,应该本着描述性以及唯一性这两大特征来命名,才能保证资源之间不冲突,并且每一个都便于记忆。命名规范要望文知义,简单明了。

文件夹: 全部英文小写字母 + 数字或连接符 -

命名严谨性

代码中的命名严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式。

说明:正确的英文拼写和语法可以让阅读者易于理解,避免歧义。注意,即使纯拼音命名方式也要避免采用。

  • 正例:henanluoyangrmb 等国际通用的名称,可视同英文。

  • 反例:DaZhePromotiongetPingfenByName

项目命名

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

  • 正例:my-project

  • 反例:my_projectmyProject

目录命名

参照项目命名规范;

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

  • 正例:scriptsstylescomponentsimagesutilsdemo-stylesdemo-scriptsimg

  • 反例: scriptstyledemo_scriptsdemoStylesimgs

文件命名

JS、CSS、Less、SCSS、HTML、图片文件命名

采用小写方式, 以-分隔

  • 正例: render-dom.jsreset.cssindex.htmlcompany-logo.png

  • 反例: UserManagement.html

vue、jsx、tsx 文件命名 可能有争议

采用小写方式, 以-分隔

  • 正例: index.vueindex.jsxindex.tsxhello-world.vuehello-world.tsx

  • 反例: UserManagement.vue

Lint 工具

使用ls-lint 插件实现文件名制约,有 Lint 工具自动集成