南山e铝网前端开发文档

开发

文档地址

https://www.zybuluo.com/hotjp/note/791022

框架

• amazeui

现有模组

• jquery
• jsonp 跨域插件
• moment 时间处理
• urlparas url处理
• webuploader 上传
• base64 前端base64加密
• holder 错误图替换
• jquery.cookie
• jquery.lazyload 懒加载图片
• artTemplate-native 模板引擎
• zoomify 放大镜

编码规范

HTML

• 4空格缩进
• 空标签禁止换行
• 各模块间保留注释，尤其结尾处
• 禁止冗余嵌套
• body元素统一使用大驼峰为页面命名className，允许使用单个单词 IndexTitle
• 定义style用className使用 _ 做连字符，允许使用单个单词 index_title
• 与JS绑定的className或id统一使用小驼峰命名，禁止使用单个单词 indexTitle
• <script> <link> 标签不需要type属性

CSS

• 使用less编译css
• 4空格缩进
• 无样式空代码段禁止上传至svn
• 只允许修改个人独立less文件
• 保留代码注释，按页面及功能模块添加,注释写在花括号内部
• 代码上传前需格式化less文件并提交最新的style.css及style.css.map
• less编译后选择器建议不超过5层
• 使用私有前缀声明自有变量xx-，需置于各自less文件开头
• 所有颜色相关需使用独立变量声明的，请自行声明

JS

• 2空格缩进
• 如使用TS、coffeeScript、es6等请自行编译ES5
• 使用ESlint进行js代码风格检查通过后提交
• 使用JSdoc完成函数注释，每个js文件均署名
• 保留代码执行思路相关注释(如if...else的两个分支、变量的赋值说明等）
• 事件绑定统一使用 $.fn.on 绑定在直接元素上（$('.addEventBtn').on('click',function(){})）
• 其他参考：《JavaScript编码规范》

代码管理

• svn管理提交代码，最长提交周期为一天，最短为一个完成页面
• 提交新文件，需填写提交说明
• 提交未完成功能，需填写提交说明
• 开发期间提交他人代码改动，需填写提交说明
• 提交代码如遇冲突，解决后重新提交需要填写提交说明
• 未完成的功能需添加TODO:/FIXME:等注释信息