达邻项目前端开发规范

书写规范

HTML规范

1、所有标签必须嵌套规范,不允许出现内联元素内部嵌套块级元素(因为设计到手机开发,a标签内可以嵌套块级元素)

2、嵌套规则必须明晰,不能有多余嵌套,可以做多层嵌套调整兼容性

3、类名和ID必须明确,不公用的需用ID,公用的需用类名

4、注释必须,必须在所有页面模型前使用注释,注释需表明此模块的开始和结束。

LESS规范

因为本项目使用LESS开发,所以需要项目中的人熟悉LESS语法

1、公用的混合全部放在/less/framework/mixin目录下,同类的混合放在同一个文件中

2、合理使用嵌套规则,不应该有深层的嵌套

3、公用的变量文件,全部放在/less/framework/variables文件中

4、自己的less文件放在/less目录下,所有的项目需要包含在less/style.less文件中

5、每个模块需要创建一个less文件,less文件不应该过大

6、注释,每个less文件需要说明模块的详细信息,和作者信息,每个嵌套开始和结束加上注释

CoffeeScript规范

因为本项目使用CoffeeScript开发,需要遵循CoffeeScript开发规范

1、所有函数后必须有return,不返回值则return;如果需要返回最后一行则不用书写return

2、方法与方法间需要隔开两个空行

3、函数的回调不能过深,如果过深,需要拆解回调

4、注释必须明晰,每个函数需要标明返回值,返回类型,参数类型和参数值

 

 

命名规范

1、css类名规范以下划线为标准,如main_content,main_container,div_1,div_2,不使用驼峰。

2、cssID名以驼峰为准,如mainContentmainContainer, divFirst.divSecond

3、CS调用页面上为JS预留的接口,尽量不调用类名和css ID名,JS预留接口为ID名,如:JsMainContent,JsMainContainer

4、CS变量命名为驼峰命名,函数内部的临时变量命名为 开头, 如:_height,_width

5、CS常量命名为全大写,如:MAIN_WIDTHMAIN_HEIGHT

6、CS对象命名,首字母大写,如:Main

 

文件命名规范

文件命名必须清晰,明了,明确知道该文件的作用,所有文件遵循项目结构,使用驼峰式命名规范。

 

所有开发必须遵循以上的开发规则

发表评论

电子邮件地址不会被公开。


*