请选择 进入手机版 | 继续访问电脑版

Discuz! Board

 找回密码
 立即注册
搜索
热搜: 活动 交友 discuz
查看: 5086|回复: 0

前端开发规范

[复制链接]

9

主题

14

帖子

189

积分

管理员

Rank: 9Rank: 9Rank: 9

积分
189
发表于 2022-6-9 10:17:35 | 显示全部楼层 |阅读模式
1 前端开发规范
1.1  文件规范
(1)所有与页面元素类图片均应该放入img文件夹,图片格式以gif/png/jpg。
(2)文件夹命名全部使用小写英文/数字/”_”的组合,其中不得包含汉字/空格/特殊字符,尽量使用易懂的词汇,便于团队其它成员理解。比如ad_left01    btn_submit
1.2  HTML书写规范
(1)一遍情况下css文件放在body部分<meta>标签后,js文件放在<body>标签尾部;
(2)文件应以<!doctype html>首行定格开始,告诉浏览器是一个什么文件;
(3)必须在head元素内部的meta标签内声明文档的字符编码charset,如:<metacharset="UTF-8">;
(4)避免行内CSS代码,在页面中尽量避免使用style属性,即style="…";
(5)必须为含有描述性表单元素(input,textarea)添加label,如姓名:须写成:姓名:
(6)标签中的class、属性、自定义属性的值,要用双引号 “” 包裹;
1.3  CSS规范
(1)在pc和移动端,会引入默认的公共样式文件,命名为base.css(里面包括了常用的公共样式) ;
(2)指定一定的注释规范(比如按照组件之间或者按照页面形式拆分,方便复用);
(3)在写css样式是避免嵌套层级过多,尽量少于3级;
(4)除去某些极特殊的情况,尽量不要使用 !important。
(5)class 应以功能或内容命名,不以表现形式命名;
(6)class 与 id 单词字母小写,多个单词组成时,采用中划线“-”分隔;
(7)避免过多使用JS执行动画,尽量使用css动画;
(8)搭建框架的命名比如
  
框架构造
  
命名
容器
container
页头
header
内容
content/container
页面主体
main
页尾
footer
导航
nav
侧栏
sidebar
栏目
column

1.4  JS书写规范
(1)书写过程中,每行代码结束必须有分号;
(2)变量命名:驼峰是命名,变量要求是纯英文字母,另要求集中声明,避免全局变量;
(3)常量:使用全部字母大写,单词间下划线分隔的命名方式;
如: var  HTML_ENTITY = {}
(4)函数命名:首字母小写驼峰式命名;如: function getStyle(element) {} ;
(5)js方法代码结构明了,对重要的方法和变量添加适量注释,提高函数重用率;
(6)JavaScript注释, 单行注释使用‘//这儿是单行注释’ ,多行注释使用;/**/ ;
(7)注重与html分离,避免将js直接写入html文档里面,注重浏览器性能;
(8)引入JS库文件,文件名须包含库名称及版本号及是否为压缩版,比如jquery-1.4.1.min.js;
(9)使用循环语句时注意性能问题,如:遍历查询判断可以使用break终止后续循环;
(10)每开发完一个页面,前端控制台所有打印全部注释掉;
(11)根据项目需求,保证各浏览器的兼容性,若不兼容IE或移动端的项目,尽量使用ES6语法;
(12)对于响应时间较长的接口,制作加载动画提高用户体验;
(13)对于定时器的使用,有声明就要有清除;
1.5  接口命名规范
(1)可读性强,见名晓义;
(2)尽量写全。不用缩写,除非是下面列表中约定的;(变量以表达清楚为目标)
  
常用词
  
说明
options
表示选项,与 jQuery 社区保持一致,不要用 config, opts 等
active
表示当前,不要用 current 等
index
表示索引,不要用 idx 等
trigger
触点元素
triggerType
触发类型、方式
context
表示传入的 this 对象
object
推荐写全,不推荐简写为 o, obj 等
element
推荐写全,不推荐简写为 el, elem 等
length
不要写成 len, l
prev
previous 的缩写
next
next 下一个
min
minimize 的缩写
max
maximize 的缩写
DOM
不要写成 dom, Dom


回复

使用道具 举报

您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

Archiver|手机版|小黑屋|立达政通科技集团

GMT+8, 2026-6-8 13:41 , Processed in 0.054124 second(s), 18 queries .

Powered by Discuz! X3.4

Copyright © 2001-2021, Tencent Cloud.

快速回复 返回顶部 返回列表