前端代码规范

第一部分

1.命名通用规则

1)使用英文命名

let dizhi='' // bad

let address=''  // good

2)使用有意义的单词组合

function getData(){}  // bad

function getUserInfo(){}  // good

3)避免使用数字名称

let icon1='' 
let icon2='' // bad

let phoneIcon=''
let mailIcon=='' // good

3)避免使用‘广告’、‘推广’等字样 如‘guanggao’、 ‘advertisement’、‘ad’等,因为有的浏览器会拦截,造成文件加载失败

2.文件夹/目录命名规则

1)使用小驼峰

HelpCenter // bad
help_center // bad 
help-center // bad

helpCenter // good

3.项目名称命名规则

1)使用下划线链接

test_project // good

4.js文件命名规则

1)普通js文件使用小驼峰

2)如果js文件导出的是一个对象,使用小驼峰

3)如果js文件导出的是一个类,使用大驼峰,文件名与类名一致

5.css文件命名规则

1)使用小驼峰

6.html文件命名规则

1)使用小驼峰

7.js中变量名命名规则

1)一般使用小驼峰

2)‘ID’在变量名中全大写

let userId='' // bad

let userID='' // good

3)‘URL’在变量名中全大写

let baseUrl='' // bad

let baseURL='' // good

4)‘IOS’在变量名中全大写

let isIos=true // bad

let isIOS=true // good

5)常量全大写,使用下划线链接

const baseUrl='' // bad

const BASE_URL='' // good

8.js文件中function的命名规则

1)使用小驼峰

2)回调函数以‘on’开头

function clickHandler(){} // bad

function onSubmit(){} // good
function onCustomEvent(){} // good

3)表示动作的函数以动词开头

如‘getUserData()’、‘calculateDistance()’

4)返回值为Boolean类型的函数以‘is’或者‘has’开头

如‘isDone()’、‘hasChild()’

9.css文件中class命名规则

1)使用中短杠链接‘-’

.userInfo{} // bad

.user-info{} // good

2)最好使用后缀表示元素的性质

后缀如 ‘-btn’、‘-list’、‘-item’、‘-header’,让人一目了然
容器级别的后缀依次为‘wrapper’ 、‘container’、‘box’、‘content’

.comfirm-btn // good
.brand-list // good
.brand-item // good
.index-header // good

10.图片文件命名规则

1)使用下划线链接‘_’

arrowLeft.png // bad
arrow-left.png // bad

arrow_left.png // good

2)最好使用后缀表示性质

后缀如 ‘_icon’、‘_bg’、“_logo”

3)不同分辨率的图片使用‘@2x’的形式结尾,x为小写

第二部分

1.统一使用vs code编写代码,使用prettier格式化代码

2.使用2空格进行缩进

3.暂定使用eslint strandrad作为规范,个别规则可自行忽略

eslint-standard

4.建议吧项目中用到的图片放到一个文件夹里,便于查找和替换

第三部分 VUE项目规范

1.VUE项目中禁止引入jquery

2.合理划分组件,如果单个VUE文件代码超过500行,需要主动要求组长review代码

3.VUE文件使用小驼峰命名

4.VUE对象属性按照顺序写

export default{
  mixins: [],
  components: {},
  props:{},
  data(),
  computed:{},
  watch:{},
  lefttimes(), // 生命周期回调函数啊,按照生命周期的顺序写
  methods: {} // 按照执行顺序和对业务影响程度来排序
  filters:{}
}

5.表示元素是否显示的变量使用show开头

如‘showVoteModal’、‘showUserName’

6.禁止使用index.vue命名文件

7.在自定义组件中的prop必须指定类型和默认值

props: {
    color: {
      type: String,
      default: '#fff',
    },
}

第四部分 jquery开发规范

1.避免使用全局变量,代码都放在ready回调函数中或者使用立即执行函数

ready回调中

$(function(){
  // 你的代码
})

立即执行函数中

(function(){
   // 你的代码 
})()

2.提取公用方法,避免重复代码

如获取URL中参数的方法,格式化时间的方法

3.尽量使用ID选择器

4.html文件中id字段命名为小驼峰格式

5.缓存对象

$('#content').addClass('red')
$('#content').empty()  // bad

var content=$('#content')
content.addClass('red')
content.empty() // good

6.在循环中,尽量减少dom操作

var brandData=[] // 有一个数组
var brandList=$('#bandList') // 获取到容器的jQuery对象
for(var i=0;i<brandData.length;i++){
  brandList.append('<li>'+brandData[i]+'</li>')
} //  bad

var brandStr='' //  用一个字符串存储html片段
for(var i=0;i<brandData.length;i++){
  brandStr+='<li>'+brandData[i]+'</li>'
}
brandList.html(brandStr) // good 使用数组 join()来拼接字符串速度更快

第五部分 杂项

1.尽量使用背景图,减少使用img标签,避免图片拉伸

2.git

1)每天下班前往git上推代码

2)区分使用master分支和dev分支

3)项目上线后往master上合并代码

4)写有意义的commit message

3.图片如果没有透明部分,使用jpg格式

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,843评论 6 502
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,538评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 163,187评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,264评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,289评论 6 390
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,231评论 1 299
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,116评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,945评论 0 275
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,367评论 1 313
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,581评论 2 333
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,754评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,458评论 5 344
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,068评论 3 327
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,692评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,842评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,797评论 2 369
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,654评论 2 354

推荐阅读更多精彩内容

  • 本规范参考Google HTML/CSS Style Guideline和Google Javascript St...
    LeapDeXign阅读 1,245评论 5 3
  • 一、前端编辑器 vscode 对angular、typescript有着非常友好的支持,轻便快捷,代码统一,一键格...
    ElliottsSu阅读 969评论 0 2
  • 如果你能认真读完此文,将对你收益匪浅! 目录 初衷 文件/资源命名 HTML CSS JavaScript 编辑器...
    强哥科技兴阅读 6,877评论 1 2
  • 初衷 不管参与项目的人数有多少,确保每一行代码都像是同一个人编写的; 根据实际情况制定良好的代码规范; 遵守编码风...
    强哥科技兴阅读 467评论 0 1
  • 前端代码规范 JavaScript代码编写规范 缩进 每一层级由4个空格组成,避免使用制表符(Tab)进行缩进。 ...
    佛系少女不佛系阅读 1,329评论 0 1