命名规范-js/css
参考 https://www.yuque.com/fengyinchao/ze2e30/hy9wrn
JS 命名规范
- 变量:小驼峰式命名法、前缀应当是名词(函数的名字前缀为动词,以此区分变量和函数)、尽量在变量名字中体现所属类型,如:length、count 等表示数字类型;而包含 name、title 表示为字符串类型
- 常量:名称全部大写、使用大写字母和下划线来组合命名,下划线用以分割单词
- 函数: 小驼峰式命名法、前缀应当为动词、可使用常见动词约定。
动词 | 含义 | 返回值 |
---|---|---|
can | 判断是否可执行某个动作(权限相关) | boolean |
should | 判断是否应该执行某个动作(展示相关) | boolean |
has | 判断是否含有某个值 | boolean |
is | 判断是否为某个值 | boolean |
get | 获取某个值 | 返回相应数据 |
set | 设置某个值 | 无返回、返回是否成功或返回链式对象 |
load | 加载某些数据 | 无返回值或者返回是否加载完成的结果 |
- 类 & 构造函数: 大驼峰式命名法,首字母大写 、 前缀为名称
css 命名规范
按照 CSS 的性质和用途,将 CSS 文件分成“公共型样式”、“特殊型样式”、“皮肤型样式”,并以此顺序引用(按需求决定是否添加版本号)。
- 公共型样式:包括了以下几个部分:“标签的重置和设置默认值”、“统一调用背景图和清除浮动或其他需统一处理的长样式”、“网站通用布局”、“通用模块和其扩展”、“元件和其扩展”、“功能类样式”、“皮肤类样式”。
- 特殊型样式:当某个栏目或页面的样式与网站整体差异较大或者维护率较高时,可以独立引用一个样式:“特殊的布局、模块和元件及扩展”、“特殊的功能、颜色和背景”,也可以是某个大型控件或模块的独立样式。
- 皮肤型样式:如果产品需要换肤功能,那么我们需要将颜色、背景等抽离出来放在这里。
CSS 内部的分类及其顺序
- 重置(reset)和默认(base)(tags):消除默认样式和浏览器差异,并设置部分标签的初始样式,以减少后面的重复劳动!你可以根据你的网站需求设置!
- 统一处理:建议在这个位置统一调用背景图(这里指多个布局或模块或元件共用的图)和清除浮动(这里指通用性较高的布局、模块、元件内的清除)等统一设置处理的样式!
- 布局(grid)(.g-):将页面分割为几个大块,通常有头部、主体、主栏、侧栏、尾部等!
- 模块(module)(.m-):通常是一个语义化的可以重复使用的较大的整体!比如导航、登录、注册、各种列表、评论、搜索等!
- 元件(unit)(.u-):通常是一个不可再分的较为小巧的个体,通常被重复用于各种模块中!比如按钮、输入框、loading、图标等!
- 功能(function)(.f-):为方便一些常用样式的使用,我们将这些使用率较高的样式剥离出来,按需使用,通常这些选择器具有固定样式表现,比如清除浮动等!不可滥用!
- 皮肤(skin)(.s-):如果你需要把皮肤型的样式抽离出来,通常为文字色、背景色(图)、边框色等,非换肤型网站通常只提取文字色!非换肤型网站不可滥用此类!
- 状态(.z-):为状态类样式加入前缀,统一标识,方便识别,她只能组合使用或作为后代出现(.u-ipt.z-dis{},.m-list li.z-sel{}),具体详见命名规则的扩展相关项。
功能类和皮肤类样式为表现化的样式,请不要滥用!以上顺序可以按需求适当调整。