• web前端代码规范


    Web前端开发规范文档。目的是在写前端的时候更加规范化。

    1、通用规范

    • TAB键用两个空格代替(WINDOWS下TAB键占四个空格,LINUX下TAB键占八个空格)。
    • CSS样式属性或者JAVASCRIPT代码后加“;”方便压缩工具“断句”。
    • 文件内容编码均统一为UTF-8。
    • CSS、JAVASCRIPT中的非注释类中文字符须转换成unicode编码使用,以避免编码错误时乱码显示。

    2、html书写规范

    2.1 为每个HTML页面的第一行添加标准模式(standard mode)的声明,确保在每个浏览器中拥有一致的展现。

    1. <!DOCTYPE html>

    2.2 文档类型声明统一为HTML5声明类型,编码统一为UTF-8。

    1. <meta charset="UTF-8">

    2.3 <HEAD>中添加信息。

    1. <meta name="author" content="smile@kang.cool">//作者
    2. <meta name="description" content="hello">//网页描述
    3. <meta name="keywords" content="a,b,c">//关键字,“,”分隔
    4. <meta http-equiv="expires" content="Wed, 26 Feb 1997 08:21:57 GMT">//设定网页的到期时间。一旦网页过期,必须到服务器上重新调阅
    5. <meta http-equiv="Pragma" content="no-cache">//禁止浏览器从本地机的缓存中调阅页面内容
    6. <meta http-equiv="Window-target" content="_top">//用来防止别人在框架里调用你的页面
    7. <meta http-equiv="Refresh" content="5;URL=http://kahn1990.com/">//跳转页面,5指时间停留5秒 网页搜索机器人向导。用来告诉搜索机器人哪些页面需要索引,哪些页面不需要索引
    8. <meta name="robots" content="none">//content的参数有all,none,index,noindex,follow,nofollow,默认是all
    9. <link rel="Shortcut Icon" href="favicon.ico">//收藏图标
    10. <meta http-equiv="Cache-Control" content="no-cache, must-revalidate">//网页不会被缓存

    2.4 非特殊情况下CSS样式文件外链至HEAD之间,JAVASCRIPT文件外链至页面底部

    1. <!DOCTYPE html>
    2. <html>
    3. <head>
    4. <link rel="stylesheet" href="css/main.css">
    5. </head>
    6. <body>
    7. <!-- 逻辑代码 -->
    8. <!-- 逻辑代码底部 -->
    9. <script src="lib/jquery/jquery-2.1.1.min.js"></script>
    10. </body>
    11. </html>

    2.5 引入JAVASCRIPT库文件,文件名须包含库名称及版本号及是否为压缩版。

    1. jQuery-1.8.3.min.js

    2.6 引入JAVASCRIPT插件, 文件名格式为库名称+.+插件名称

    1. jQuery.cookie.js

    2.7 HTML属性应当按照以下给出的顺序依次排列,来确保代码的易读性。

    1. class
    2. id name
    3. data-*
    4. srcfor type href
    5. titlealt
    6. aria-*、 role

    2.8 书写链接地址时避免重定向。

    1. href="http://www.kahn1990.com/" //即在URL地址后面加“/”

    编码均遵循XHTML标准, 标签、属性、属性命名由小写英文、数字和_组成,且所有标签必须闭合,属性值必须用双引号””, 避免使用中文拼音尽量简易并要求语义化。

    1. CLASS --> nHeadTitle --> CLASS遵循小驼峰命名法(little camel-case
    2. ID --> n_head_title --> ID遵循名称+_
    3. NAME --> N_Head_Title --> NAME属性命名遵循首个字母大写+_
    4. <div class="nHeadTitle" id="n_head_title" name="N_Head_Title"></div>

    多用无兼容性问题的HTML内置标签, 比如SPAN、EM、STRONG、OPTGROUP、LABEL等,需要自定义HTML标签属性时,首先考虑是否存在已有的合适标签可替换,如果没有, 可使用须以“data-”为前缀来添加自定义属性,避免使用其他命名方式。

    3、css书写规范

    3.1 为了欺骗W3C的验证工具,可将代码分为两个文件,一个是针对所有浏览器,一个只针对IE。即将所有符合W3C的代码写到一个文件中,而一些IE中必须而又不能通过W3C验证的代码(如: cursor:hand;)放到另一个文件中,再用下面的方法导入。

    1. <!-- 放置所有浏览器样式-->
    2. <link rel="stylesheet" type="text/css" href="">
    3. <!-- 只放置IE必须,而不能通过w3c的-->
    4. <!--[if IE]
    5. <link rel="stylesheet" href="">
    6. <![endif]-->

    3.2 CSS样式新建或修改尽量遵循以下原则。

    1. 根据新建样式的适用范围分为三级:全站级、产品级、页面级。
    2. 尽量通过继承和层叠重用已有样式。
    3. 不要轻易改动全站级CSS。改动后,要经过全面测试。

    3.3 CSS属性显示顺序。

    1. 显示属性
    2. 元素位置
    3. 元素属性
    4. 元素内容属性

    3.4 CSS书写顺序。

    1. .header {
    2. /* 显示属性 */
    3. display || visibility
    4. list-style
    5. position top || right || bottom || left
    6. z-index
    7. clear
    8. float
    9. /* 自身属性 */
    10. width max-width || min-width
    11. height max-height || min-height
    12. overflow || clip
    13. margin
    14. padding
    15. outline
    16. border
    17. background
    18. /* 文本属性 */
    19. color
    20. font
    21. text-overflow
    22. text-align
    23. text-indent
    24. line-height
    25. white-space
    26. vertical-align
    27. cursor
    28. content
    29. };

    3.5 兼容多个浏览器时,将标准属性写在底部。

    1. -moz-border-radius: 15px; /* Firefox */
    2. -webkit-border-radius: 15px; /* Safari和Chrome */
    3. border-radius: 15px; /* Opera 10.5+, 以及使用了IE-CSS3的IE浏览器 *//标准属性

    3.6 使用选择器时,命名比较短的词汇或者缩写的不允许直接定义样式。

    1. .hd,.bd,.td{};//如这些命名

    可用上级节点进行限定。

    1. .recommend-mod .hd

    多选择器规则之间换行,即当样式针对多个选择器时每个选择器占一行。

    1. button.btn,
    2. input.btn,
    3. input[type="button"] {…};

    优化CSS选择器。 #header a { color: #444; };/CSS选择器是从右边到左边进行匹配/

  • 相关阅读:
    使用 logger 在脚本中输出多个日志
    MySQL 5.7 安装完成后,立即要调整的性能选项
    多线程练习2_龟兔赛跑
    多线程练习1_网图下载
    【BFS(预处理)+SPFA】【NOIP2013】华容道
    【数学】【NOIP2013】解方程
    【二分答案+倍增】【NOIP2015】运输计划
    std::strncpy 简介
    text 文本去重行
    关于string::copy()的比较详细的示例
  • 原文地址:https://www.cnblogs.com/gerry/p/7591003.html
Copyright © 2020-2023  润新知