WEB前端编码规范



《WEB前端编码规范》由会员分享,可在线阅读,更多相关《WEB前端编码规范(47页珍藏版)》请在装配图网上搜索。
1、 XXXX有限公司 XXXXXXXX管理平台 Web 前端代码编写规范 文件状态: 文件标识: [ √ ] 草稿 当前版本: 1.0 [ ] 正式发布 作 者: 李光强 [ ] 正在修改 完成日期: 2016.1.30 XXXXXX 2016 年 1
2、 月 修改历史 修订后 修订人 修订 编号 修订内容简述 版本号 日期 11.0 李光强 起草 2016.1.30 第一部分 HTML 规范 HTML并不是一种编程语言,而是一种标记语言,它没有任何真正的编程语 言中的循环或是流程控制语句。然而, HTML代码的格式和风格是非常重要的,因为要经常对 HTML代码进行维护和修改, 因此 HTML代码必须有很清晰的逻辑结构和布局,而使其易懂和易于维护。 HTML语言是不区分大小写的,但为改善
3、可读性,规定小写所有字母(除最 上一行引用外) 。与 HTML不一样, XHTML对大小写是敏感的,
4、 2. 网站 head 区代码规范: head 区是指
和 之间的内容。必须加入的标签: 2.1 公司版权注释 2.2 网页显示字符集 简体中文 : 繁体中文:5、ta http-equiv="Content-Type" content="text/html; charset= BIG5"> 英 语: 2.3 作者与版权信息 此处用于存储开发公司版权信息,如: 2.4 网页的 c
6、ss,javascript 规范 在引用 CSS和 JS文件时,统一放置在
中,先放 CSS引用,再放 js 引用。 html 中 javascript 的书写: 2.5 网页标题 Title 中使用“ - ”分割,如:设备管理平台 - 运维系统7、。 2.6 设置搜索关键词 百度关键词搜索指数: ,在这个工具里, 可以看到一些常用关键词的每日搜 索次数。 热门词汇,目前收索量最多的词汇。可以查看百度热词榜, Google AdWords 关键字工具:查询特定关键词的常见查询及扩展匹配。 KEYWRODS关键字最多不超过 5 个建议长度:小于等于 100 个汉字,如果使用的网页编码是 UTF-8,不同关键字之间用英文“ , ”分隔。 2.7 网站简介
8、 description 是描述网页内容的, 因此最好是可以用一句话来概括本网页的 主题内容。 description 不要超过 255 个字符,搜索引擎索引一般都会索引 Description 的前 255 个字符,因此,这 255 个字符是做搜索引擎优化的关键。 如果使用的网页编码是 UTF-8,那么在 Description 中的标点符号最好都使 用英文,例如英文的逗号、句号等。如果是中文的话,那么就使用中文的标点符 号即可。 2.
9、8 其它标签 [ 非必需 ] 1. 设定网页的到期时间。 一旦网页过期, 必须到服务器上重新调阅, 这样有利于页面信息。 2. 禁止浏览器从本地机的缓存中调阅页面内容。 3. 用来防止别人在框架里调用你的页面。 4. 自动跳转。 5 指时间停留 5 秒。 5. 网页搜索机器人向导 . 用来告诉搜索机器人哪些页面需要索引,哪些页面不需要索引。 CONTENT的参数有 all,none,index,noindex,follow,nofollow 。默认是 all 。 6. 收藏夹图标 图片大小 16px*16px 7. 订阅 RSS浏览 是一种描述和同步网站内容的格式。用户可以通过 RSS阅读器订阅。 2.9 完整示例
12、 3. html 中元素的书写:
区域标签 3.1 段落 段落使用标签进行定义。
This is a paragraph
3.2 标题 即正文标题一般用 标签,最好和 title 标签的内容有关联。 标题使用 至 标签进行定义。 定义最大的标题。 定义
最小的标题。
This
定义最大的标题。 定义
最小的标题。
This
This
13、is a heading
This is a heading
This is a heading
This is a heading
This is a heading
This is a heading
文章中的小标题一定也要加粗。 可以把网页中的重要内容做成这样。 用户不用登陆这个网页就可看到更新的内容。 3.3 字体的设置标签 换行:字体修饰不要使用
14、> 等进行标注,一般使用 css 样式进行字体 样式排版 3.4 注意事项 1.
为了保证浏览器的兼容性 ,必须设置页面背景: 2. 关 所有的 打开的 必 关 ,例如 ,当然 有一种关 方式,如:。 即:一定要有 束 。 3. 属性 用双引号 “” 括起来 , 属性 一使用小写 例如:

16、t 属性指定了当 片不能 示的 候就 示供替 文本。 内容最好与关 相关。
如:
一些小 最好用 .png 或 .gif 格式 片,比如 箭 ,文章列表前的 等,在 CSS中做成背景。 些小 最好做一 片,用 CSS来定位。
9. 用 构化的元素 出内容
- 新现代
- 新现代
- 新现代
- <
17、/dt>
⋯⋯ | ⋯ .
19、 4. HTML 元素的排序规则 能够使用的 HTML元素包括: div 、p、ul 、table 、span、input 、select 等。基本上 div 、table 、ul 、p 都属于结构性比较强的元素,而 span、input 则是比较弱的元素,因此不允许有 span 嵌套 div 、 table 等等的情况出现, span 可以嵌套 input, 可以嵌套 span。 在写页面的时候可以先不考虑界面呈现, 按照这样的规则, 把数据直接绑定到 HTML元素的节点上。 5. 九大原则 原则一: 一般要写兼容多种浏览器的
20、网页, 最省事的方法就先写适合 chrome 的样式,并在 chrome 进行调度。测试时可以使用多种浏览器。 原则二: 逐步叠加的方式,如果需要用这个样式的模块很多, 并且会存在些许的不同,千万不要把样式一步写到位, 最好把框架性的先写好, 细节性的留到第二个步骤,甚至第三个步骤,当然最好步骤不要超过三步,这样很不利于维护。 由若干个二级定义对一级定义进行补充, 这样的既可以减少代码, 又可以减少繁多的 CLASS命名。 不要轻易修改共用的 CSS,否则可能会影响其它页面。 在每个一级 CSS前添加注释,说明哪些页面使用了该 CSS。
21、 原则三: 从总到分。顺序应该是这样:总体需要用到的 >>结构 >>模块 >>二级模块 >> 细节;并且这个文档最不容易修改的处于最上端, 频繁用于修改的在末端。 最忌讳即兴发挥, 这样写出的东西经不起推敲, 稍有变化就要忙得乱成一团。 结构性的东西应该慎重精细。 原则四: 尽量把能够放在一组的小图标或者图片放在一个图片文件里, 这样的好处有很多。 1、 图片文件的总量会变小; 2、利于下载,太多的小图片下载效果是不理想的,常常会发现这个图片出 来,那个没出来, 这样在写样式的时候只需要写一个总体的, 对于具体的要显
22、示 的只需要标一个位置,非常省时间,样式也很精炼; 3、 显而易见,这样做非常便于管理,替换或新增的时候工作量很小。 原则五: 切图的原则, 应该切大的图绝不切小, 应该切小的绝不切大, 能够用颜色代替的绝不切图。 把一个大图切成很多份并不一定能够加快页面的显示速度, 相反会浪费很多不必要的带宽。 不光要控制图片文件的多少, 还要考虑到这样切会不会造成页面增加许多额外的代码。 原则六: 图片使用能名称表达图片意义的名词命名,尽量不要使用编号命名。 原则七: 涉及多行多列的特别是列宽有不固定的,坚决用表格,千万不要为
23、了 DIV 而 DIV。 多个图片规则排列时,可以使用
24、模块(子系统)单独创建一个文件夹,使 用与之相关的有意义的英文名词命名。 例如有一个系统包括后台管理 (admin)、 前台商城( shop)、会员中心( member)和商家中心( store )等子系统,文件 夹组织: 每个子系统中应该包含一个缺省的 html 文件,文件名统一用 index.html ,即当用户缺省访问该目录时,自动加载该页面。 公用页面(如登录 login.html 、页头 header.html 、页脚 footer.html 、导 航 navigation.
25、html 、菜单 menu.html 、信息 / 错误提示 message.html 等),可以统一放在 common目录中。 6.2 页面命名规则 具有管理功能的页面,如用名、角色、设备、日志、文章等的管理,可以归 纳为列表( list.htm )、新建( add.html )、编辑( edit.html )等几类操作, 所以在页面组织时, 每类模块单独创建一个文件夹, 使用能够表达模块意义的英 文名词命名,并在其中分别创建 list.html 、add.html 、 edit.html 等文件,对 应于内容列表、添加、编辑等操作。
26、示例: 其它说明: 1. 在列表页面里统一使用“四栏式”显示风格,即列表页面里必须包括模块目录 / 位置提示、工具栏(含添加、编辑、删除、刷新、查询等操作控件)、表格、分页操作等部分。示例: 2. 表格用于显示查询内容,在 list.html 打开时,必须默认加载一定的记录;表格栏目仅
27、显示用户常用或关心的字段; 在显示时必须对表格内容进行必要的格式处理;对记录常用的操作可以放置于操作栏内 (如上图中的操作栏内放置有编辑和删除两个操作按钮)。 3. 表格可以统一使用 easyui datagrid 或 bootstap data tables 。 6.3. 资源文件的命名原则 资源文件包括 css 、js 、图片等内容。所有资源文件统一存储在 web 根目录 resource 文件夹中。示例:
28、 每个子系统(大类)文件夹命名规则同 6.1 规则。 每个子系统文件夹中分别包括 css 、 js 和 images,示例: 多个子系统公共使用的资源,统一存储在 common文件夹中,如常用的 js 操作,可以命名为 generic.js ,放置在 common/js/generic.js 。 6.3 图片命名规则 图片分成两部分, 一是网页设计时使用的静态资源, 通常不会因系统的运行而发生变化,另一类是程序生成、用户上传、终端上传的图片。 (
29、1)静态图片存储在 大类目录 \images 中,使用能表达图片意 义的英文单词命名, 不能使用图片编号命名。 网面使用的小图标, 可以放置在一个图片文件中,使用 css 裁切和背景方式显示在页面中。 (2)动态图片存储在 resources\upload 目录中,在其中创建分类图片目录。 例如,与系统相关的图片存储在 system 目录中,设备监控相关图片存储在 management 中等。为了避免同一文件夹中文件数量限制,在分类目录中,按上 传日期分成不同的次级目录, 命名规则为上传文件所在的 yyyyMM(年度月份),其中月份使用
30、两位数字表示。例如: 上传的图片统一使用 GUID标识进行命名, 即在上传时,由接收的 java 程序自动生成 guid 编号 +. 图片扩展名进行命名。 注意:保存图片时,文件扩展名必须保持不变。示例: 7. 常用 HTML标识符 HTML 标记一览 : 标记 类型 译名或意义 作 用 备注 文件标记 ● 文件声明 让浏览器知道这是 HTML 文件
31、● 开头 提供文件整体资讯
○
段落标记
为字、画、表格等之间留一空白行
○
换行标记
令字、画、表格等显示于下一行
○ 水平线 插入一条水平线
● 预设格式 令文件按照原始码的排列方式显示32、
● 区隔标记 设定字、画、表格等的摆放位置● 不折行 令文字不因太长而绕行 ● 建议折行 预设折行部位 字体标记 ● 加重语气 产生字体加粗 BOLD 的效果 ● 粗体标记 产生字体加粗的效果 ● 强调标记 字体出现斜体效果 ● 斜体标记 字体出现斜体效果 ● 打字字体 COURIER字体,字母宽度相同 ● 加上底线 加上底线 反对 ● 一级标题标记 变
33、粗变大加宽,程度与级数反比
● 二级标题标记 将字体变粗变大加宽
● 三级标题标记 将字体变粗变大加宽
● 四级标题标记 将字体变粗变大加宽
● 五级标题标记 将字体变粗变大加宽
● 六级标题标记 将字体变粗变大加宽 ● 字形标记 设定字形、大小、颜色 反对
○ 基准字形标记 设定所有字形、大小、颜色 反对 ● 字体加大 令字体稍为加大 ● 字体缩细 令字体 34、稍为缩细
● 画线删除 为字体加一删除线 反对● 程式码 字体稍为加宽如 ● 键盘字 字体稍为加宽,单一空白 ● 范例 字体稍为加宽如 ● 变数 斜体效果 ● 传记引述 斜体效果
● 引述文字区块 缩排字体 ● 述语定义 斜体效果 ● 地址标记 斜体效果 ● 下标字 下标字 ● 上标字35、 指数(平方、立方等) 清单标记
● 顺序清单 清单项目将以数字、字母顺序排列
● 无序清单 清单项目将以圆点排列
- ○ 清单项目 每一标记标示一项清单项目
反对
● 目录清单 清单项目将以圆点排列,如 反对
● 定义清单 清单分两层出现
- ○ 定义条目 标示该项定义的标题
- ○ 定义内容 标示定义内容 表格标记
36、BLE> ● 表格标记 设定该表格的各项参数
● 表格标题 做成一打通列以填入表格标题 ● 表格列 设定该表格的列 ● 表格栏 设定该表格的栏 ● 表格标头 相等于 ,但其内之字体会变粗 表单标记