Cubee 手册
What's Cubee?
- cubee是由淘宝北京UED团队开发并维护的UI库和widget代码库。
- UI规范将指导北京数字产品的开发,降低设计和开发成本,提高产品的模块化程度和提高重用率
- cubee包含UI指南和代码库两部分
- 更多内容:cubeewiki
开发者
- VD:夏之、人马、宁凝、常洛
- WD:乐渔、拔赤、霸先、卓群、道觉、大彪
开发须知
- 代码路径:http://svn.simba.taobao.com/svn/UED/trunk/DPD/cubee
- 全局内容:reset,grid,font等,包含在global.css中,组件开发依赖这些通用样式
- widget开发时命名空间统一使用类似“Y.MsgBox”的格式,如果是类或构造器(需要new的),使用Y.MsgBox的形式,首字母大写,如果是简单函数,使用Y.dosth的形式,首字母小写,多单词的名称使用驼峰命名,js编码规范不强制,可以参照js编码规范
- 文件编码统一采用utf-8格式
- css中class的命名格式不强制,推荐使用"c-xx-yy"的格式,id的命名不强制
- 在widget开发完成后,需要版本发布的时候,须有讨论通过,并且有必要的代码review
文档撰写
- 开发者整理完整一个模块的源码到src后,应当在这里完善相应的文档
- src中应当包含演示的demo,比如弹出层的demo在src/box/demo中
- 文档起始页是start.php
- 每个模块的文档页应当在doc/page/中,页面格式参照doc/page/box.php,通过http://url/doc/start.php?box,box为文件名,不包含后缀
- 开发者需要整理的内容应当包含:演示、代码示例、API(如果需要)。
- 更新后别忘了提交代码啊