前端规范大总结

目的:为了提高工作效率,便于后台人员添加功能及前端后期优化维护,输出高质量的文档,在网站建设中,使结构更加清晰,代码简明有序,有一个更好的前端架构。

基本准则:符合web标准,使用具有语义的标签,使结构、表现、行为分离,兼容性优良。页面性能优化,代码简洁、明了、有序,尽可能的减少服务器的负载,保证最快的解析速度。

 

一、文件规范

1.1 HTML部分

  1.1.1 建包问题

    文件均归档至约定的目录中,建包格式如下:

    

前端规范大总结

    注意:所有的css文件放在css文件夹中,image放在images文件夹中,js放在js文件夹中

  1.1.2 HTML头部编写

    (1) 编码:所有编码均采用xhtml/html,标签必须闭合,编码统一为UTF-8,在多语言的网站建议添加<html lang="zh-CN">,说明内容是以中文显示和阅读为基础的

    (2) 语义化:正确使用标签,充分利用无兼容性问题的html自身标签

    (3) 文件头部head内容:

      • title: 需要添加标题

      • 编码: charset=UTF-8

      • meta: 可以添加description、keywords内容

1.2 CSS部分

  1.2.1 CSS种类及其命名

    可以将CSS样式表分为三类:全局样式表、模块通用样式表和独立样式表

      • 全局样式表常用命名:public.css

      • 模块通用样式表命名:模块名_basic.css

      • 独立样式表:模块名_页面名.css

  1.2.2 CSS引入

    CSS文件引入可通过外联或者内联方式引入

  • 外联方式

  • 内联方式

    

前端规范大总结

    注意:link和style标签都应该放入head中,原则上,不允许在html上直接写样式。避免在CSS中使用@import,嵌套不要超过一层。

 

二、注释规范

2.1 顶部文档注释(推荐使用)

1 /* 2 * @description: 中文说明 3 * @author: name 4 * @update: name(xxxx-xx-xx xx:xx) 5 */

内容版权声明:除非注明,否则皆为本站原创文章。

转载注明出处:https://www.heiqu.com/zggjzj.html