# Ulimob
**Repository Path**: dlm2015/Ulimob
## Basic Information
- **Project Name**: Ulimob
- **Description**: ulimob微商平台
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 1
- **Created**: 2015-09-28
- **Last Updated**: 2020-12-19
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
营销平台
=================
##展望
###URL规范
####规范的目的
URL是每一个网页的入口. 一个好的网站, 必须是有一个合理的网站结构. 一个好的URL规则就是好网站的体现.
- 用户的使用考虑
- 网站分析考虑
- SEO考虑
####URL组成
`protocol :// hostname[:port] / path / [;parameters][?query]#fragment `
`协议://主机名[:端口]/ 路径/[:参数] [?查询]#Fragment`
####不规范的URL:
- URL中多余的字符
1. 子域名的URL中包含 `www`, 如: [http://www.gh.example.com/](http://www.gh.example.com/)
2. 含有默认端口, 如: [http://www.example.com:80/h/](http://www.example.com:80/h/)
3. 松散的URL, 如: [http://www.example.com/books/amazon-sucks-donkey-balls/9780470170779-item.html](http://www.example.com/books/amazon-sucks-donkey-balls/9780470170779-item.html)
4. 多余默认文件名`index.html`, `index.php`等, 如: [http://www.example.com/index.html](http://www.example.com/index.html)
5. 文件路径中多余的 `/`, 如: [http://www.example.com/gh//](http://www.example.com/gh//)
6. 文件路径中多余的点修饰串, 如: [http://www.example.com/a/b/http://www.163.com/../page.html](http://www.example.com/a/b/http://www.163.com/../page.html)
7. 查询串中多余的 `?` (空查询串): [http://www.example.com/shudo?](http://www.example.com/shudo?)
8. 查询串中多余的 `&`: [http://www.example.com/shudo?id=123&](http://www.example.com/shudo?id=123&)
9. 查询串中无用的查询变量: [http://www.example.com/display?id=123&faint=faint](http://www.example.com/display?id=123&faint=faint)
- URL缺少字符串
1. 缺少"/", 如: [http://www.example.com/gh](http://www.example.com/gh)
2. 查询串缺少名称或者值, 如: [http://www.example.com/display/?id=](http://www.example.com/display/?id=) 或者 [http://www.example.com/display/?=123](http://www.example.com/display/?=123)
- 其他不规范的URL
1. [http://gh.example.com/](http://gh.example.com/) 与 [http://www.example.com/gh/](http://www.example.com/gh/) 内容相同
2. 使用IP代替域名
3. 含有扩充字符(extended characters)，大小写敏感, 如: [http://www.google.cn/Intl/zh-CN/about.html](http://www.google.cn/Intl/zh-CN/about.html) 和 [http://www.google.cn/intl/zh-CN/about.html](http://www.google.cn/intl/zh-CN/about.html)
4. "+"和"%20"混用, 如: [http://www.example.com/gh/a+b%20c/](http://www.example.com/gh/a+b%20c d%2Be/)
###模块
###公共约定
测试入口为根目录 `/`
需在服务器环境下读取
如: [http://localhost/](http://localhost/)
本项目是基于 `Node.js` 开发
其开发学习曲线平缓, 架构简洁易上手
####文件目录
- /
> 总目录
- /node_modules
> 项目所需模块目录
- /routes
> 项目业务逻辑处理目录
- /views
> 页面html模板目录
- /public
> 公共静态文件目录
- /public/css
> 公共样式文件目录
- /public/js
> 公共javascript文件目录
- /public/img
> 公共图片目录
- /upload
> 公共上传目录
- /upload/模块名
> 公共上传分类目录, 根据需使用此目录的模块名称进行命名
##前端
使用html5某些标签
尚未进行IE6+等浏览器兼容
####模板说明
`index.htm`为基底页面模板, 所有独立页面均以此做为父模板继承
html代码中标识相应include, 使用此前端项目可按照模板引擎相应加载
>示例
####规范
######规范目的
为提高团队协作效率, 便于后台人员添加功能及前端后期优化维护, 输出高质量的文档, 特制订此文档. 本规范文档一经确认, 前端开发人员必须按本文档规范进行前台页面开发. 本文档如有不对或者不合适的地方请及时提出, 经讨论决定后方可更改.
######基本准则：
符合web标准, 语义化`html`, 结构`html` & 表现 `css` & 行为 `js` 分离, 兼容性优良. 页面性能方面, 代码要求简洁明了有序, 尽可能的减小服务器负载, 保证最快的解析速度.
######文件规范
- `html`, `css`, `js`, `images` 文件均归档至<文件目录>约定的目录中
- `html`文件均以 `.htm` 后缀命名, 忌大小写混用. 以 `.htm` 命名, 如: `message-show.htm` 非必要不允许使用数字, 如 `index2.htm`
- `css`文件均以 `.css` 后缀命名, 忌大小写混用. 以 `.css` 命名, 如: `index.css` 非必要不允许使用数字, 如 `index2.css`
- `javascript`文件均以 `.js` 后缀命名, 忌大小写混用.共用 `common.js`, 其他依实际模块需求以 `.js` 命名, 如: `index.js` 非必要不允许使用数字, 如 `index2.js`
- 所有文件均以 `UTF-8` 进行编码
######编码风格
- html代码均为半角小写, 禁止大小写混用, 制表符空格混用
- 4空格缩进
######html书写规范
- 文档类型声明 ``
- 编码 ``
- 书写时利用IDE实现层次分明的缩进
- 非特殊情况下 `JavaScript` 文件必须外链至页面底部
- 引入JS库文件, 文件名须包含库名称及版本号及是否为压缩版, 比如 `jquery-1.8.3.min.js`
- 引入插件, 文件名格式为库名称+插件名称, 比如 `jQuery.cookie.js`
- 所有编码均遵循 `xhtml` 标准, 标签 & 属性 & 属性命名 必须由小写字母及连接符数字组成, 且所有标签必须闭合, 包括 br `
`, hr `
`等
- 需要为 `html` 元素添加自定义属性的时候, 首先要考虑下有没有默认的已有的合适标签去设置, 如果没有, 可以使用须以 `data-` 为前缀来添加自定义属性，避免使用 `data:` 等其他命名方式
- 属性值必须用双引号包括, 如 `链接`
- 充分利用无兼容性问题的 `html` 自身标签, 比如`span`, `em`, `strong`, `optgroup`, `label` 等等
- 语义化html, 如 标题根据重要性用 `h*` (同一页面只能有一个`h1`), 段落标记用 `p`, 列表用 `ul`, 内联元素中不可嵌套块级元素;
- 尽可能减少 `div` 嵌套
>示例:
>反例:
- 书写链接地址时, 必须避免重定向，例如：`链接`, 即须在URL地址后面加上 `/`
- 在页面中尽量避免使用style属性, 即 `示例`
- 必须为含有描述性表单元素 `input`, `textarea` 添加 `label`
>示例
>反例
姓名:
- 能以背景形式呈现的图片, 尽量写入css样式中
>示例
span{
background: rgba(0, 0, 0, 0) url("/ui/bg.gif") 0 -120px no-repeat;
}
- 重要图片必须加上alt属性
>示例
- 给重要的元素和截断的元素加上title
- 给区块代码及重要功能(比如循环)加上注释, 方便后台添加功能
>示例
- 特殊符号使用: 尽可能使用代码替代: 比如 < `<`, > `>`, 空格 ` ` 等等
- 书写页面过程中, 请考虑向后扩展性
- class & id 参见 css书写规范
######css书写规范
- <项目维护者> 会根据各个模块, 同时根据页面相似程序, 事先写好大体框架文件, 分配给前端人员实现 内部结构 & 表现 & 行为
- 共用 `css` 文件 `base.css` 由 <项目维护者> 编写, 协作开发过程中, 每个页面请务必都要引入, 此文件包含reset及 头部 底部样式, 此文件不可随意修改
- `id` 是唯一的并是父级的, `class` 是可以重复的并是子级的, 所以 `id` 仅使用在大的模块上, `class` 可用在重复使用率高及子级中
- `id` 原则上都是由项目维护者分发框架文件时命名的, 为 `JavaScript` 预留钩子的除外
- 为 `JavaScript` 预留钩子的命名, 请以 `js-` 起始, 比如: `js-hide`, `js-show`
- 大的框架命名比如 `header` & `footer` & `wrapper` & `left` & `right` 之类的统一由 <项目维护者> 命名.其他样式名称由 `小写英文` & `数字` & `_` 来组合命名, 如 `i_comment`, `fontred`, `width200`.
- 规避class与id命名, 若有不明白请及时与 <项目维护者> 沟通:
>示例
`html基底模板`
Examples
`模块实现`
Examples
`css`
/*命名规避*/
#mainnav .firstnav{
/* code */
}
- css属性书写顺序, 建议遵循
1. 布局定位属性
> - margin
> - padding
> - float
> - position
> - display
> - visibility
> - overflow
2. 自身属性
> - width
> - height
> - background
> - border
3. 文本属性
> - font
> - color
> - text-align
> - text-decoration
> - text-indent
4. 其他属性
> - list-style
> - vertical-vlign
> - cursor
> - z-index
> - zoom
> - ..........
- 书写代码前, 考虑并提高样式重复使用率;
- 充分利用html自身属性及样式继承原理减少代码量
>示例: 日期居右显示
`html`
`css`
ul.list li{
position:relative;
}
ul.list li span{
position:absolute;
right:0
}
- 样式表中中文字体名, 请务必转码成unicode码, 以避免编码错误时乱码;
- 背景图片请尽可能使用sprite技术, 减小http请求, 考虑到多人协作开发, sprite按模块制作;
- 使用 `table` 标签时, 请不要用 `width` & `height` & `cellspacing` & `cellpadding` 等table属性直接定义表现, 应尽可能的利用table自身私有属性分离结构与表现, 如 `thead` & `tr` & `th` & `td` & `tbody` & `tfoot` & `colgroup` & `scope`
>css控制方法
table{
border:0;
margin:0;
border-collapse:collapse;
}
table th, table td{
padding:0;
}
- 杜绝使用 `` 兼容ie8
- 用png图片做图片时, 要求图片格式为png-8格式,若png-8实在影响图片质量或其中有半透明效果, 请为ie6单独定义背景
>示例
img{
_background:none;
_filter:progid:DXImageTransform.Microsoft.AlphaImageLoader(sizingMethod=crop, src="img/bg.png");
}
- 减少使用影响性能的属性, 比如 `position:absolute` || `float`
- 必须为大区块样式添加注释, 小区块适量注释
######JavaScript书写规范
- 书写过程过, 每行代码结束必须有分号;
- 原则上所有功能均根据项目需求原生开发, 以避免网上down下来的代码造成的代码污染 || 沉冗代码 || 与现有代码冲突 || …
- 原则上仅引入jQuery库, 若需引入第三方库, 须与团队其他人员讨论决定
- 变量以首字母小写驼峰式命名, 要求变量集中声明, 避免全局变量
>示例
var showTime;
- 构造函数与工厂函数命名以首字母大写, 驼峰式命名
>示例
var MsgPush = function(){
this.type = 'info';
this.msg = 'cool';
}
- 函数命名: 首字母小写驼峰式命名
>示例
var getOrder = function(){
// code
}
function getOrder(){
// code
}
- 命名语义化, 尽可能利用英文单词或其缩写
- 尽量避免使用存在兼容性及消耗资源的方法或属性, 比如 `eval()` & `innerText`
- 代码结构明了, 加适量注释, 提高函数重用率
- 注重与html分离, 减小reflow, 注重性能
######图片规范
- 格式只允许 `gif`, `png`, `jpg` 三种格式
- 全部用小写英文字母 || 数字 || - 的组合，其中不得包含汉字 || 空格 || 特殊字符
- 尽量用易懂的词汇, 便于团队其他成员理解
- 命名分头尾两部分, 用连接符隔开, 比如: `btn-submit.gif`
- 在保证视觉效果的情况下选择最小的图片格式与图片质量, 以减少加载时间
- 运用 `css sprite` 技术集中小的背景图或图标, 减小页面 `http` 请求
######注释规范
- html
>示例
- css
>示例
div{
/*这儿是注释*/
}
- JavaScript
>示例
var func = function(){
// 这儿是注释
}
######开发工具
- Sublime Text
- Chrome
亦可根据自己喜好选择, 但须遵循如下原则:
1. 不可利用IDE的视图模式'画'代码
2. 不可利用IDE生成相关功能代码, 比如Dw内置的一些功能js
3. 编码必须格式化, 比如缩进
######测试
- 前期开发仅测试`Chrome` & `FireFox` & `IE11` & `IE10` & `IE9`, 后期优化时加入 `IE8` & `IE7` & `IE6`;
- 建议测试顺序 `Chrome` –> `FireFox` –> `IE11` –> `IE10` –> `IE9`, 建议安装 `firebug` 及 `IETester`
######其他规范
- 开发过程中严格按分工完成页面, 以提高css复用率, 避免重复开发;
- 减小沉冗代码, 书写所有人都可以看的懂的代码.
- 简洁易懂是一种美德.
- 为用户着想, 为服务器着想.
##后台
###Node.js