项目结构规范

① 项目结构

 |---- index.html             //入口页    
 |---- js/                    //JS ,具体见CSS 文件结构                 
 |---- css/                   //CSS ,具体见CSS 文件结构
 |---- /images                //公共图片

② CSS 文件结构

 --- ../css/
 |---- css/libs/reset.css                  //CSS reset文件
 |---- … … 
 |---- css/images/                         //主 CSS-sprite 图片     
 |---- css/style.css                       //主 CSS 样式表
 |---- … … 
 |---- css/images/xxx/sprite.png           //xxx 的 CSS-sprite 图片
 |---- css/xxx-style.css                   //xxx 的 样式表

③ JS 文件结构

 ---/js/
|---- /libs/plugin-1/       //使用到的js插件1  
|---- /libs/plugin-2/       //使用到的js插件2  
|---- /libs/plugin-3/       //使用到的js插件3  
|---- script.js             //单独书写的js  
|---- plugins.js            //调用的plugins汇总  
|---- juqery-1.9.x.min.js   //调用jq库文件

④ 命名规范

  • 文件及文件夹: 全部英文小写字母 + 数字或连接符"-" , "_" ,不可出现其他字符 如:"../css/style.css, jquery.1.x.x.js"
  • 文件:调用 "/libs" 文件需包含版本号,压缩文件需包含"min"关键词,其他插件则可不包含 如:"/libs/jquery.1.9.1.js" "/libs/modernizr-1.7.min.js" "fileuploader.js" "plugins.js"
  • ID: [匈牙利命名法] & [小駝峰式命名法]
    如:"firstName" "topBoxList" "footerCopyright"
  • Class: [减号连接符]
    如:"top-item" "main-box" "box-list-item-1"
  • 尽量使用语义明确的单词命名,避免 "left" "bottom" 等方位性的词语

⑤ 格式&编码

  • 文本文件: .xxx UTF-8(无BOM) 编码
  • 图片文件: .png (PNG-24) .jpg (压缩率8-12)
© QIANSR all right reserved,powered by Gitbook该文件修订时间: 2015-11-30 17:12:05