html+文件注释规范,前端注释规范.doc

前端注释规范

前端注释规范

篇一：Web前端开发规范手册

Web前端开发规范手册

一、规范目的

1.1 概述 ..................................................................................................................................... 1

二、文件规范

2.1 文件命名规则.........................................................................................................................1

2.2 文件存放位置..........................................................................................................................2

2.3 css 书写规范..........................................................................................................................3

2.4 html书写规范.........................................................................................................................7

2.5 JavaScript书写规范.............................................................................................................11

2.6 图片规范...................................................................................................................................12

2.7 注释规范...................................................................................................................................13

2.8 css 浏览器兼容.......................................................................................................................13

一、规范目的

1.1 概述

为提高团队协作效率, 便于后台人员添加功能及前端后期优化维护, 输出高质量的文档, 特制订此文档. 本规范文档一经确认, 前端开发人员必须按本文档规范进行前台页面开发. 本文档如有不对或者不合适的地方请及时提出, 经讨论决定后可以更改此文档.

二、文件规范

2.1 文件命名规则

文件名称统一用小写的英文字母、数字和下划线的组合，其中不得包含汉字、空格和特殊字符；命名原则的指导思想一是使得你自己和工作组的每一个成员能够方便的理解每一个文件的意义，二是当我们在文件夹中使用“按名称排例”的命令时，同一种大类的文件能够排列在一起，以便我们查找、修改、替换、计算负载量等等操作。

a. HTML的命名原则

引文件统一使用index.htm index.html index.asp文件名(小写)

各子页命名的原则首先应该以栏目名的英语翻译取单一单词为名称。例如：

关于我们 \ aboutus

信息反馈 \ feedback

产 品 \ product

如果栏目名称多而复杂并不好以英文单词命名，则统一使用该栏目名称拼音或拼音的首字母表示； 每一个目录中应该包含一个缺省的html 文件，文件名统一用index.htm index.html index.asp；

b. 图片的命名原则

图片的名称分为头尾两部分，用下划线隔开，头部分表示此图片的大类性质

例如：广告、标志、菜单、按钮等等。

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

标志性的图片取名为： logo

在页面上位置不固定并且带有链