开发规范

为了更好书写可维护的代码,在不管多久以后都能看懂自己写的代码,就需要规范自己的代码。

驼峰式命名方式

大驼峰命名——首字母大写 UserInfo
小驼峰命名——首字母小写 userInfo

文件资源命名

文件名不能有空格。
文件名建议只使用小写字母,不使用大写字母。
为了醒目,某些说明的文件名,可以使用大写字母,例如README。
文件名包含多个单词,建议单词之间用 “-”分隔。
引入资源使用相对路径,不要指定资源的具体协议(http或https),除非两者协议都不可用。

变量命名

小驼峰命名

命名规则: 类型+对象的描述方式,如没有明确的类型,就可以使前缀为名词
array a
boolean b
function f
init i
object o
string s

函数命名

小驼峰命名
命名规则: 前缀为动词
返回值
can 判断是否可以执行某个动作 函数返回boolean true 可执行 false 不可执行
has 判断是都含有某个值 boolean true含有此值 false 不含此值
is 判断是否是某个值 boolean true为某个值 false 不为某个值
get 获取具体单个值 函数返回一个非布尔值
set 设置具体单个值 无返回值,返回是否设置成功或返回链式对象
//是否可以阅读
function canRead(){
return true
}
//获取姓名
function getName(){
return this.name
}

常量

全部大写
规则: 大写字母+下划线来组合命名,多个单词之间用_进行分隔
var URL = 'http://dhejhf.com';
var MAX_COUNT = 100;

类的成员

公共属性: 同变量命名
公共方法: 同函数命名
私有属性: 前缀为下划线_,下划线后面跟公共属性和方法一样的命名方式
私有方法:

function Student(name){
var _name = name //私有属性
//公共方法
this.getName = function (){
return -name
}
}

HTML开发规范
文档规范

文档声明类型:
使用文档声明类型是为了防止浏览器开启怪异模式。
如果不写,就会开启怪异模式,浏览器就会按照自己的解析方式渲染页面,在不同浏览器下会有不同样式。
如果写入!DOCTYPE html>,就等于开启浏览器标准模式,浏览器会按照W3C标准解析渲染页面。

脚本加载

所有浏览器推荐 js放在下面,css放在上面。
针对不同的兼容需求,那么js放置的位置也可以不一样。
如果只需要兼容ie10+或只在移动端访问,那么可以使用async,将js脚本文件放在内

只在老旧浏览器(ie9-)中,
脚本引用写在 body 结束标签之前,并带上 async 属性。这虽然在老旧浏览器中不会异步加载脚本,但它只阻塞了 body 结束标签之前的 DOM 解析,这就大大降低了其阻塞影响。而在现代浏览器中:
脚本将在 DOM 解析器发现 body 尾部的 script 标签才进行加载,此时加载属于异步加载,不会阻塞 CSSOM(但其执行仍发生在 CSSOM 之后)。
所有浏览器推荐形式:








只兼容现代浏览器推荐:








html只关注内容

html只显示展示内容信息
不要引入一些特定的html结构来解决视觉设计问题
不要讲img元素当做专门用来做视觉设计的元素
样式上的问题应该使用css解决

js规范
不写全局变量

在一般情况下,我们还是少些全局变量,避免命名空间被污染。
为了防止全局变量,一般都是将代码包裹在立即执行函数中,常见一个独立的作用域。立即执行完后立即释放。

变量声明

总是用var来声明变量。
var xx=1;
如果不指定var,变量就会隐式声明为全局变量。
var a=b=0;
等同于:
var a =0
b=0 //如果在全局中都没有找到b,则为隐式的声明为全局变量

js变量提升

js在执行代码时,会先将代码中的声明的变量提升,再执行。

禁止修改对象的原型链
最好不要修改 比如 Object.prototype, Function.prototype, 可能会导致开过程中遇到问题。

css规范
calss 命名规则

命名名称总是反应元素目的和用,或者而是其他通用名称。

基于功能(eg:侧边栏 sidebar)
基于内容 (eg: 内容是个人信息 personalnews)
也就是说 命名体现功能、 内容,不涉及表现样式(颜色 字体 背景等)

css样式可以按照以下顺序排列

1 位置相关的属性,定位
2 盒模型 margin padding width height border display
3 文字相关 字体 字体大小 字体颜色 居中
4 视觉 圆角 背景色 边框颜色

合理使用id

因为id的权重很高,建议不应该用于样式,而是使用class。

css中不使用标签名

遵循结构 行为 表现 分离的原则,应该尽量在css中不出现html标签。

你可能感兴趣的:(开发规范)