web开发规范文档二

  1. 头部        header\hd
  2. 内容块      content\con\bd
  3. text
  4. txt
  5. title
  6. 尾部        footer
  7. 导航        nav\menu
  8. sub-nav\sub-menu
  9. 侧栏        side-con
  10. 栏目        item
  11. 外容器      wrapper\sprite
  12. 左右中      left\right\center
  13. 上下        top\bot
  14. 登录        login-bar
  15. 标志        logo
  16. 横栏、广告  banner
  17. 主体        main-container
  18. 热点        hot
  19. 新闻        news
  20. 下载        download
  21. 搜索        search
  22. 友情链接    friend-link
  23. 版权        copy-right
  24. 标签        tab
  25. 列表        list
  26. post-list
  27. 评论信息    cmt
  28. 提示信息    msg\note
  29. 小备注      tips
  30. 注册        regsiter
  31. 图标        icon
  32. 表单        fm
  33. input-text

用有意义的或通用的ID和class命名：ID和class的命名应反映该元素的功能或使用通用名称，而不要用抽象的晦涩的命名。反映元素的使用目的是首
选；使用通用名称代表该元素不表特定意义，与其同级元素无异，通常是用于辅助命名；使用功能性或通用的名称可以更适用于文档或模版变化的情况。

- /* 不推荐: 无意义 */ #yee-1901 {}
- /* 不推荐: 与样式相关 */ .button-green {}.clear {}
- /* 推荐: 特殊性 */ #gallery {}#login {}.video {}
- /* 推荐: 通用性 */ .aux {}.alt {}
常 用命名（多记多查英文单词）：page、wrap、layout、header(head)、footer(foot、ft)、
content(cont)、menu、nav、main、submain、sidebar(side)、logo、banner、
title(tit)、popo(pop)、icon、note、btn、txt、iblock、window(win)、tips等

ID和class命名越简短越好，只要足够表达涵义。这样既有助于理解，也能提高代码效率。

- /* 不推荐 */ #navigation {}.atr {}
- /* 推荐 */ #nav {}.author {}

类型选择器避免同时使用标签、ID和class作为定位一个元素选择器；从性能上考虑也应尽量减少选择器的层级。

- /* 不推荐 */ul#example {}div.error {}
- /* 推荐 */#example {}.error {}
命名时需要注意的点：

- 规则命名中，一律采用小写加中划线的方式，不允许使用大写字母或 _
- 命名避免使用中文拼音，应该采用更简明有语义的英文单词进行组合
- 命名注意缩写，但是不能盲目缩写，具体请参见常用的CSS命名规则
- 不允许通过1、2、3等序号进行命名
- 避免class与id重名
- id用于标识模块或页面的某一个父容器区域，名称必须唯一，不要随意新建id
- class用于标识某一个类型的对象，命名必须言简意赅。
- 尽可能提高代码模块的复用，样式尽量用组合的方式
-
规则名称中不应该包含颜色（red/blue）、定位（left/right）等与具体显示效果相关的信息。应该用意义命名，而不是样式显示结果命名。
1、常用id的命名：

(1)页面结构

- 容器: container
- 页头：header
- 内容：content/container
- 页面主体：main
- 页尾：footer
- 导航：nav
- 侧栏：sidebar
- 栏目：column
- 页面外围控制整体布局宽度：wrapper
- 左右中：left right center

(2)导航

- 导航：nav
- 主导航：mainbav
- 子导航：subnav
- 顶导航：topnav
- 边导航：sidebar
- 左导航：leftsidebar
- 右导航：rightsidebar
- 菜单：menu
- 子菜单：submenu
- 标题: title
- 摘要: summary

(3)功能

- 标志：logo
- 广告：banner
- 登陆：login
- 登录条：loginbar
- 注册：regsiter
- 搜索：search
- 功能区：shop
- 标题：title
- 加入：joinus
- 状态：status
- 按钮：btn
- 滚动：scroll
- 标签页：tab
- 文章列表：list
- 提示信息：msg
- 当前的: current
- 小技巧：tips
- 图标: icon
- 注释：note
- 指南：guild
- 服务：service
- 热点：hot
- 新闻：news
- 下载：download
- 投票：vote
- 合作伙伴：partner
- 友情链接：link
- 版权：copyright
四、书写规范

1、排版规范(1)使用4个空格，而不使用tab或者混用空格+tab作为缩进；(2)规则可以写成单行，或者多行，但是整个文件内的规则排版必须统一；单行形式书写风格的排版约束

- 如果是在html中写内联的css，则必须写成单行；
- 每一条规则的大括号 { 前后加空格 ；
- 每一条规则结束的大括号 } 前加空格；
- 属性名冒号之前不加空格，冒号之后加空格；
- 每一个属性值后必须添加分号; 并且分号后空格；
- 多个selector共用一个样式集，则多个selector必须写成多行形式 ；
多行形式书写风格的排版约束

- 每一条规则的大括号 { 前添加空格;
- 多个selector共用一个样式集，则多个selector必须写成多行形式 ;
- 每一条规则结束的大括号 } 必须与规则选择器的第一个字符对齐 ;
- 属性名冒号之前不加空格，冒号之后加空格;
- 属性值之后添加分号;

  • 使开发流程更加规范化。

通用规范：

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

文件规范：

  • 文件名用英文单词，多个单词用驼峰命名法。
  • 一些浏览器会将含有这些词的作为广告拦截：ad、ads、adv、banner、sponsor、gg、guangg、guanggao等，文件命名、ID、CLASS等所有命名避免以上词汇。

html书写规范：

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

    1. <!DOCTYPE html>

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

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

    <HEAD>中添加信息。

    1. <meta name="author" content="[email protected]">//作者
    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">//网页不会被缓存

    IE支持通过特定<meta>标签来确定绘制当前页面所应该采用的IE版本。除非有强烈的特殊需求，否则最好是设置为edge mode ，从而通知IE采用其所支持的最新的模式。

    1. <meta http-equiv="X-UA-Compatible" content="IE=Edge">

  • 非特殊情况下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>

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

    1. jQuery-1.8.3.min.js

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

    1. jQuery.cookie.js

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

    1. class
    2. id 、 name
    3. data-*
    4. src、for、 type、 href
    5. title、alt
    6. aria-*、 role

    编码均遵循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>

    当JAVASCRIPT获取单个元素时，通常使用document.getElementById来获取dom元素，document.getElementById兼容所有浏览器，但IE浏览器会混淆元素的ID和NAME属性，所以要区分ID和NAME命名。

    1. <input type="text" name="test">
    2. <div id="test"></div>
    3. <button onclick="alert(document.getElementById(‘test‘).tagName)"></button>
    4. <!-- ie6下为INPUT -->

  • 特殊符号应使用转意符。

    1. < --> &lt;
    2. > --> &gt;
    3. 空格 --> &nbsp;
  • 含有描述性表单元素（INPUT，TEXTAREA）添加LABEL。
    1. <p>
    2. <label for="test">测试</label>
    3. <input type="text" id="test" />
    4. </p>
  • 多用无兼容性问题的HTML内置标签, 比如SPAN、EM、STRONG、OPTGROUP、LABEL等,需要自定义HTML标签属性时，首先考虑是否存在已有的合适标签可替换，如果没有, 可使用须以“data-”为前缀来添加自定义属性，避免使用其他命名方式。
  • 语义化HTML。
  • 尽可能减少<DIV>嵌套。
  • 书写链接地址时避免重定向。
    1. href="http://www.kahn1990.com/" //即在URL地址后面加“/”
  • HTML中对于属性的定义，确保全部使用双引号，绝不要使用单引号

css书写规范：

  • 为了欺骗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]-->
  • CSS样式新建或修改尽量遵循以下原则。
    1. 根据新建样式的适用范围分为三级：全站级、产品级、页面级。
    2. 尽量通过继承和层叠重用已有样式。
    3. 不要轻易改动全站级CSS。改动后，要经过全面测试。
  • CSS属性显示顺序。
    1. 显示属性
    2. 元素位置
    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. };

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

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

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

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

    可用上级节点进行限定。

    1. .recommend-mod .hd

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

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

    优化CSS选择器。

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

    浏览器将检查整个文档中的所有链接和每个链接的父元素，并遍历文档树去查找ID为header的祖先元素，如果找不到header将追溯到文档的根节点，解决方法如下。

    1. 避免使用通配规则和相邻兄弟选择符、子选择符,、后代选择符、属性选择符等选择器
    2. 不要限定id选择符，如div#header（提权的除外）
    3. 不要限定类选择器，如ul.recommend（提权的除外）
    4. 不要使用 ul li a 这样长的选择符
    5. 避免使用标签子选择符，如#header > li > a

  • 使用z-index属性尽量z-index的值不要超过150（通用组的除外），页面中的元素内容的z-index不能超过10（提示框等模块除外但维持在150以下），不允许直接使用（999~9999）之间大值。

  • 尽量避免使用CSS Hack。
    1. property:value; /* 所有浏览器 */
    2. +property:value; /* IE7 */
    3. _property:value; /* IE6 */
    4. *property:value; /* IE6/7 */
    5. property:value\9; /* IE6/7/8/9，即所有IE浏览器 */
    1. * html selector { … }; /* IE6 */
    2. *:first-child+html selector { … }; /* IE7 */
    3. html>body selector { … }; /* 非IE6 */
    4. @-moz-document url-prefix() { … }; /* firefox */
    5. @media all and (-webkit-min-device-pixel-ratio:0) { … }; /* saf3+/chrome1+ */
    6. @media all and (-webkit-min-device-pixel-ratio:10000),not all and (-webkit-min-device-pixel-ratio:0) { … }; /* opera */
    7. @media screen and (max-device-width: 480px) { … }; /* iPhone/mobile webkit */

    避免使用低效的选择器。

    1. body > * {…};
    2. ul > li > a {…};
    3. #footer > h3 {…};
    4. ul#top_blue_nav {…};
    5. #searbar span.submit a { … }; /* 反面示例 */

  • 六个不要三个避免一个使用。

    1. 不要在标签上直接写样式
    2. 不要在CSS中使用expression
    3. 不要在CSS中使用@import
    4. 不要在CSS中使用!important
    5. 不要在CSS中使用“*”选择符
    6. 不要将CSS样式写为单行
    7. 避免使用filter
    8. 避免使用行内（inline）样式
    9. 避免使用“*”设置{margin: 0; padding: 0;}
    10. 使用after或overflow的方式清浮动
  • 减少使用影响性能的属性。
    1. position:absolute;
    2. float:left;//如这些定位或浮动属性

    减少在CSS中使用滤镜表达式和图片repeat, 尤其在body当中,渲染性能极差, 如果需要用repeat的话, 图片的宽或高不能少于8px。

javaScript书写规范：

  • 命名规范。

    1. 常量名
    2. -->全部大写并单词间用下划线分隔
    3. -->如：CSS_BTN_CLOSE、TXT_LOADING
    4. 对象的属性或方法名
    5. -->小驼峰式（little camel-case）
    6. -->如：init、bindEvent、updatePosition
    7. -->示例：Dialog.prototype = {
    8. init: function () {},
    9. bindEvent: function () {},
    10. updatePosition: function () {}
    11. …
    12. };
    13. 类名（构造器）
    14. -->小驼峰式但首字母大写
    15. -->如：Current、DefaultConfig
    16. 函数名
    17. -->小驼峰式
    18. -->如：current()、defaultConfig()
    19. 变量名
    20. -->小驼峰式
    21. -->如：current、defaultConfig
    22. 私有变量名
    23. -->小驼峰式但需要用_开头
    24. -->如：_current、_defaultConfig
    25. 变量名的前缀
    26. -->续
  • 代码格式。
    1. "()"前后需要跟空格
    2. "="前后需要跟空格
    3. ","后面需要跟空格
    4. JSON对象需格式化对象参数
    5. if、while、for、do语句的执行体用"{}"括起来

    "{}"格式如下。

    1. if (a==1) {
    2. //代码
    3. };

    避免额外的逗号。

    1. var arr = [1,2,3,];

    for-in循环体中必须用hasOwnProperty方法检查成员是否为自身成员，避免来自原型链上的污染。

  • 长语句可考虑断行。

    1. TEMPL_SONGLIST.replace(‘{TABLE}‘, da[‘results‘])
    2. .replace(‘{PREV_NUM}‘, prev)
    3. .replace(‘{NEXT_NUM}‘, next)
    4. .replace(‘{CURRENT_NUM}‘, current)
    5. .replace(‘{TOTAL_NUM}‘, da.page_total);

    为了避免和JSLint的检验机制冲突，“.”或“+”这类操作符放在行尾。

    1. TEMPL_SONGLIST.replace(‘{TABLE}‘, da[‘results‘]).
    2. replace(‘{PREV_NUM}‘, prev).
    3. replace(‘{NEXT_NUM}‘, next).
    4. replace(‘{CURRENT_NUM}‘, current).
    5. replace(‘{TOTAL_NUM}‘, da.page_total);

    如果模块代码中，使用其它全局变量想跳过JSLint的检查，可以在该文件中加入/*global*/声明。

    1. /*global alert: true, console: true, top: true, setTimeout: true */

  • 使用严格的条件判断符。用===代替==，用!==代替!=，避免掉入==造成的陷阱 在条件判断时，这样的一些值表示false。

    1. null
    2. undefined与null相等
    3. 字符串‘‘
    4. 数字0
    5. NaN

    在==时，则会有一些让人难以理解的陷阱。

    1. (function () {
    2. var undefined;
    3. undefined == null; // true
    4. 1 == true; //true
    5. 2 == true; // false
    6. 0 == false; // true
    7. 0 == ‘‘; // true
    8. NaN == NaN;// false
    9. [] == false; // true
    10. [] == ![]; // true
    11. })();

    对于不同类型的 == 判断，有这样一些规则，顺序自上而下：

    1. undefined与null相等
    2. 一个是number一个是string时，会尝试将string转换为number
    3. 尝试将boolean转换为number
    4. 0或1
    5. 尝试将Object转换成number或string

    而这些取决于另外一个对比量，即值的类型，所以对于0、空字符串的判断，建议使用=== 。===会先判断两边的值类型，类型不匹配时为false。

  • 下面类型的对象不建议用new构造。

    1. new Number
    2. new String
    3. new Boolean
    4. new Object //用{}代替
    5. new Array //用[]代替

    引用对象成员用obj.prop代替obj["prop"]，除非属性名是变量。

  • 从number到string的转换。

    1. /** 推荐写法*/
    2. var a = 1;
    3. typeof(a); //"number"
    4. console.log(a); //1
    5. var aa=a+‘‘;
    6. typeof(aa); //"string"
    7. console.log(aa); //‘1‘
    8. /** 不推荐写法*/
    9. new String(a)或a.toString()

    从string到number的转换，使用parseInt，必须显式指定第二个参数的进制。

    1. /** 推荐写法*/
    2. var a = ‘1‘;
    3. var aa = parseInt(a,10);
    4. typeof(a); //"string"
    5. console.log(a); //‘1‘
    6. typeof(aa); //"number"
    7. console.log(aa); //1

    从float到integer的转换。

    1. /** 推荐写法*/
    2. Math.floor/Math.round/Math.ceil
    3. /** 不推荐写法*/
    4. parseInt

    字符串拼接应使用数组保存字符串片段，使用时调用join方法。避免使用+或+=的方式拼接较长的字符串，每个字符串都会使用一个小的内存片段，过多的内存片段会影响性能。

    1. /**推荐的拼接方式array的push、join*/
    2. var str=[],
    3. list=[‘测试A‘,‘测试B‘];
    4. for (var i=0 , len=list.length; i < len; i++) {
    5. str.push( ‘<div>‘+ list[i] + ‘</div>‘);
    6. };
    7. console.log(str.join(‘‘)); //<div>测试A</div><div>测试B</div>
    8. /** 不推荐的拼接方式+=*/
    9. var str = ‘‘,
    10. list=[‘测试A‘,‘测试B‘];
    11. for (var i = 0, len = list.length; i< len; i++) {
    12. str+=‘<div>‘ + list[i] + ‘</div>‘;
    13. };
    14. console.log(str); //<div>测试A</div><div>测试B</div>

  • 尽量避免使用存在兼容性及消耗资源的方法或属性。

    1. 不要使用with，void，evil，eval_r，innerText
  • 注重HTML分离, 减小reflow, 注重性能。

图片规范：

  • 命名应用小写英文、数字、_组合，便于团队其他成员理解。

    1. header_btn.gif
    2. header_btn2.gif
  • 页面元素类图片均放入img文件夹, 测试用图片放于img/testimg文件夹，psd源图放入img/psdimg文件夹。
  • 图片格式仅限于gif、png、jpg等。
  • 用png图片做图片时, 要求图片格式为png-8格式,若png-8实在影响图片质量或其中有半透明效果, 请为ie-6单独定义背景，并尽量避免使用半透明的png图片。
  • 背景图片请尽可能使用sprite技术, 减小http请求。

注释规范：

  • JAVASCRIPT、CSS文件注释需要标明作者、文件版本、创建/修改时间、重大版本修改记录、函数描述、文件版本、创建或者修改时间、功能、作者等信息。

    1. /* * 注释块 */

    中间可添加如下信息。

    1. @file 文件名
    2. @addon 把一个函数标记为另一个函数的扩张，另一个函数的定义不在源文件中
    3. @argument 用大括号中的自变量类型描述一个自变量
    4. @author 函数/类作者的姓名
    5. @base 如果类是继承得来，定义提供的类名称
    6. @class 用来给一个类提供描述，不能用于构造器的文档中
    7. @constructor 描述一个类的构造器
    8. @deprecated 表示函数/类已被忽略
    9. @exception 描述函数/类产生的一个错误
    10. @exec @extends 表示派生出当前类的另一个类
    11. @fileoverview 表示文档块将用于描述当前文件，这个标签应该放在其它任何标签之前
    12. @final 指出函数/类
    13. @ignore 让jsdoc忽视随后的代码
    14. @link 类似于@link标签，用于连接许多其它页面
    15. @member 定义随后的函数为提供的类名称的一个成员
    16. @param 用大括号中的参数类型描述一个参数
    17. @private 表示函数/类为私有，不应包含在生成的文档中
    18. @requires 表示需要另一个函数/类
    19. @return 描述一个函数的返回值
    20. @see 连接到另一个函数/类
    21. @throws 描述函数/类可能产生的错误
    22. @type 指定函数/成员的返回类型
    23. @version 函数/类的版本号
时间： 2024-10-01 06:50:32

web开发规范文档二的相关文章

WEB前端开发规范文档（转）

http://codeguide.bootcss.com/  编写灵活.稳定.高质量的 HTML 和 CSS 代码的规范上面的文档 再结合下面的规范: 无论是从技术角度还是开发视角,对于web前端开发规范文档都有一定规范,本文就css3和html5的发展前景总结了一系列的web开发文档,仅供大家参考. 规范目的 为提高团队协作效率, 便于后台人员添加功能及前端后期优化维护, 输出高质量的文档, 特制订此文档. 本规范文档一经确认, 前端开发人员必须按本文档规范进行前台页面开发. 本文档如有不对或

前端开发规范文档(html,css,js)

首先吐槽一句,本来想上传word文档的,可是发现博客不能上传word文档,这就很尴尬了. 首先声明该规范不是本人写的,网上搜前端规范发现这个很详细就先复制下来做笔记,当然不可能啥都按规范来,每个公司的规范都不一样..仅供参考 前端开发规范文档 Html规范 1 代码风格 1.1 缩进 **[强制]**使用 4 个空格作为一个缩进层级,不允许使用 2 个空格或 tab 字符: 2 属性 2.1 属性引号 **[强制]**对于属性的定义使用双引号,不允许使用单引号,不允许不使用引号: 示例: <!-

Web前端开发规范文档（google规范）

(Xee:其实没什么规范约束,但是养成一种好习惯,何乐而不为?) 我推荐去看看google的开发规范,然后从他的当中去总结自己的开发规范. Google HTML/CSS代码风格指南 Google JavaScript 编码规范指南 ------------------------------------------------------------------------------------------------------------------------------- 绝大多数项

前端开发规范文档（初稿）

总体原则 缩进 对于所有编程语言,我们要求缩进必须是软tab(用空格字符).在你的文本编辑器里敲 Tab 应该等于 4个空格 . 可读性 vs 压缩 对于维护现有文件,我们认为可读性比节省文件大小更重要.大量空白和适当的ASCII艺术都是受鼓励的.任何开发者都不必故意去压缩HTML或CSS,也不必把Javascript代码最小化得面目全非. 我们会在服务器端或build过程中自动最小化并gzip压缩所有的静态客户端文件,例如CSS和JS HTML,CSS,JS代码分离 html代码尽量保持整洁,

微信小程序开发规范文档-项目结构

*项目结构 project/ // 根目录 ├─ images/ // 图片/小图标 ├─ pages/ // pages目录 ├─ utils/ // 工具,包文件目录 ├─ app.js // 入口文件 ├─ app.wxss // 公共设置 ├─ app.json // 公共样式表 └─ project.config.json // 项目的编辑器配置 页面目录 1.由历史原因和个人习惯导致目录命名不统一,语义不清晰,不同成员在维护时难以快速识别. 目录命名应遵循以下规范: 尽量简短 采用英

微信小程序开发规范文档-注意事项

一个页面的数据如果需要被其它页面修改,则把这个页面的数据放入storage里. 目录结构符号 └ ┌ ┘ ┐ ┤ ├ ┴ ┬ ┼ │ ─ JS模块引入请使用import关键字,而非require,WXML引入模板用标签,WXSS使用@import语法,三者统一 所有方法和变量名称都使用小写camel模式,一般是动词+名词形式,尽量不要超过5个单词,如:getList,setBackImage 所有用到的常量的地方都使用全大写,下划线分隔的形式,如:EGG_CHE 使用this转换的地方,统一使用

转载：移动web开发规范

本文来源:http://blog.csdn.net/joueu/article/details/44329825 以下是规范建议,均是日常在开发当中的的一些经验,仅供参考. 移动web开发规范 一.头部声明 1.其中width=device-width就是说把页面宽度设置成和屏幕宽度一样 <meta name="viewport" content="width=device-width,initial-scale=1.0"> 2.首先我们来看看webki

Swagger UI教程 API 文档神器 搭配Node使用 web api 接口文档 mvc接口文档

两种方案 一.Swagger 配置 web Api 接口文档美化 二.通过NodeJS 发布Swagger UI 配置api 文档 先说一下简单的 Swagger 配置 web Api  Swagger-UI本身只提供在线测试功能,要集成它还需要告诉它本项目提供的各种服务和参数信息.这里就需要一些工作量了,不过好在许多第三方库已经给我们完成了这一工作.我这里用的是Swashbuckle,使用它也比较简单,直接使用Nuget添加其程序包即可: 1.初始化包  PM> Install-Package

app开发需求文档怎么写

我们在开发app前都会做需求分析,这个app开发需求文档怎么写呢?一般可以从这几点入手:确定APP方案的目标,APP方案的受众分析,APP开发方案功能设计,APP的操作系统说明方案,APP是是否是原生APP,APP方案的视觉设计,APP开发方案中的其他细节.以下是一个app开发需求文档模板,里面写清了app开发需求说明,可以参考 1.引言 1．1目的: · 阐明开发本app的目的:  1．2 项目背景 · 标识待开发app产品的名称.代码:  · 列出本项目的任务提出者.项目负责人.系统分析员.