前端编码规范

前言

首先,写这篇代码规范是为了我自己在以后的项目中方便引用,让前端人员统一标准,方便在开发中保持代码的一致性,HTML和CSS的规范参照bootstrap编码规范,以下多为JS规则

IDE要求使用webstorm,能够更方便的统一大家的代码。

语法

  • HTML和CSS用两个空格来代替制表符(tab);
  • JS用四个空格来代替制表符(tab);
  • webstorm设置HTML和CSS格式化的方法:File-Settings,Editor-CodeStyle-HTML(或者CSS),在Tabs and Indents选项卡下把TabSize和Indent的值均改为2;
  • webstorm格式化快捷键Ctrl+Alt+L;

命名规则

文件命名规则:单英文单词,多单词使用“-”连接或者小驼峰方法:

Css类名命名规则:英文单词,多单词使用“-”连接

Javasctipt命名规则:英文单词,多单词使用小驼峰

代码格式化

把webstorm的格式化换行去掉,设置方法:找到File-Settings,Editor-General-Appearance,去掉Show right margin(configured in Code Style options)的勾选

其他书写规范

<a>标签中href属性不使用时,不用#作为填充,使用空白来填充,例如:

协议

不要指定引入资源所带的具体协议。
当引入图片或其他媒体文件,还有样式和脚本时,URLs 所指向的具体路径,不要指定协议部分(http:, https:),除非这两者协议都不可用。
不指定协议使得 URL 从绝对的获取路径转变为相对的,在请求资源协议无法确定时非常好用,而且还能为文件大小节省几个字节。

注释

首先代码注释永远不嫌多,不管是不是给别人看或者协同开发,注释必须尽可能的详尽,就算是你自己写的代码也可能时间太久或者逻辑太复杂而忘记具体功能,所以一定要写注释;
其次注释能帮助你快速理解代码所做的事情,看一段有注释的代码和一段没有注释的代码是两个概念,前者可以让你很快的理解代码的用途和方法,后者需要自己慢慢分析,而时间就是开发成本;
再次注释能帮你更好的整理你的逻辑,在写注释的时候,往往能发现一些自己忽略掉的一些东西,减少挖坑的次数;

wholesale mlb jerseys cheap jerseys cheap jerseys

发表评论

电子邮件地址不会被公开。 必填项已用*标注