文章目录
前端代码规范
一、html-css-js篇
1.1 命名规范
1.1.1项目命名
全部采用小写方式,以中划线分隔。
正例:mall-management-system
反例:mall_management-system / mallManagementSystem
1.1.2 目录命名
全部采用小写格式,以中划线分隔,有复数结构时,要采用复数命名法,缩写不用复数
正例:scripts / styles / components / images / utils / layouts / demo-styles / demo-scripts / img / doc
反例:script / style / demo_scripts / demoStyles / imgs / docs
1.1.3 JS、CSS、SCSS、HTML、PNG 文件命名
全部采用小写方式,以中划线分隔。
1.1.4 命名严谨性
代码中的命名严谨使用拼音与英文混合的方式,更不允许直接使用中文的方式。即使纯拼音命名方式也要避免使用。
杜绝完全不规范的缩写,避免望文不知义
反例:AbstractClass 缩写 命名成AbsClass; condition 缩写 命名成 condi,此类随意缩写严重降低代码的可阅读性。
1.2 HTML 规范 (Vue Template 同样适用)
1.2.1 HTML 类型
使用HTML5的文档类型说明:
-
规定字符编码
-
IE 兼容模式
-
doctype大写
正例:
<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <meta name="viewport"