团队命名规范

2018-07-10  本文已影响0人  屎香味十足
版本号 作者 时间 版本 内容摘要
v1.0 eleven 2018-05-16 1.0.0 文档初始化

JS规范

1.HTML/CSS文件命名

确保文件命名总是以字母开头而不是数字,且字母一律小写,以驼峰格式命名,如:

<!-- HTML -->
fs.html
fsList.html
fsDetail.html
<!-- SASS -->
fs.scss
fsList.scss
fsDetail.scss

2.className命名

ClassName的命名应该尽量精短、明确,必须以字母开头命名,且全部字母为小写,单词之间统一使用下划线 “-” 连接

<!-- 这个是全站公用模块,祖先模块允许直接出现中线 -->
<div class="mod-info">
    <div class="mod-info-son"></div>
    <div class="mod-info-son"></div>
</div>

在jq或原生开发中,当某个className需要作为选择器使用时,className必须以‘js-’开头

<div class="mod-info js-click-box">
    <div class="mod-info-son"></div>
    <div class="mod-info-son"></div>
</div>

模块命名
全站公共模块:以 mod- 开头

<div class="mod-yours"></div>

业务公共模块:以 业务名-mod- 开头

<div class="paipai-mod-yours"></div>

3.ID的命名规范

当需要命名id时,下面事例是新增按钮的id命名

<div id="add-btn"></div>

4.className常用命名推荐

3. 图片命名

图片业务(可选) +(mod_)图片功能类别(必选)+ 图片模块名称(可选) + 图片精度(可选)

图片功能类别:

图片模块名称:

图片精度:

公共模块:
wx_mod_btn_goodlist@2x.png
wx_mod_btn_goodlist.png
mod_btn_goodlist.png 

非公共模块:
wx_btn_goodlist@2x.png
wx_btn_goodlist.png
btn_goodlist.png

4.js变量命名

引入的第三方库以——连接,自己本地的以驼峰式命名

上一篇 下一篇

猜你喜欢

热点阅读