前端规范

一 图片的命名规则

1 图片的名称分为头尾两部分,用下划线隔开,头部分表示此图片的大类性质,例如:广告、标志、菜单、按钮等等

2 常规命名

2.1 放置在页面顶部的广告、装饰图案等长方形的图片取名:banner

2.2 标志性的图片取名为:logo

2.3 在页面位置不固定并且带有链接的小图片我们取名:button

2.4 在页面上某一个位置连续出现,性质相同的链接栏目的图片我们取名:menu

2.5 装饰用的照片我们取名:pic

2.6 不带链接表示标题的图片我们取名:title

3 范例

banner_sohu.gif

banner_sina.gif

menu_aboutus.gif

menu_job.gif

title_news.gif

logo_police.gif

logo_national.gif

pic_people.jpg

二 脚本文件和动态文件命名规范

1 一般用脚本功能的英语小写缩写命名

1.1 实际模块

例如:广告条的javascript文件名为ad.js弹出窗口的javascript文件名为pop.js

1.2 共用模块

JS文件命名:英文命名,后缀.js.共用common.js.basic.js

1.3 外部资源

Jquery.min.js

Jquery.validate.js

Jquery.date.js

2 动态语言文件命名原则:见名知意

2.1 以性质描述,描述可以有多个单词,用"_"隔开,性质一般是该页面的概要

范例:register_form.aspx

register_post.aspx

topic_lock.aspx

2.2 不同模块之间,可以使用不同的前缀来进行区分

三 代码命名规范

3.1 文件名不得含有空格

3.2 文件名建议只使用小写字母,不使用大写字母。( 为了醒目,某些说明文件的文件名,可以使用大写字母,比如README、LICENSE。 )

3.3 文件名包含多个单词时,单词之间建议使用半角的连词线 ( - ) 分隔。

3.4 引入资源使用相对路径,不要指定资源所带的具体协议 ( http:,https: ) ,除非这两者协议都不可用。

3.5 变量命名:

命名方式 : 小驼峰式命名方法
命名规范 : 类型+对象描述的方式,如果没有明确的类型,就可以使前缀为名词

3.6 函数:

命名方式 : 小驼峰方式 ( 构造函数使用大驼峰命名法 )
命名规则 : 前缀为动词

3.7 常量

命名方法 : 全部大写
命名规范 : 使用大写字母和下划线来组合命名,下划线用以分割单词。

3.8 注释

若开始(/和结束(/)都在一行,推荐采用单行注释

若至少三行注释时,第一行为/,最后行为/,其他行以开始,并且注释文字与保留一个空格。

3.9 以结构化和模块化创建文件,不要胡乱创建页面和图片

4.0 单个方法尽量不要超过100行(超过的想办法拆分),单个页面尽量不要超过1000行

你可能感兴趣的:(前端规范)