添加文档

[PilockHulmes]

• [ ] 页面controller的结构的定义(const, vm) -coffee
• [ ] 对象数组的coffee语法 -coffee
• [ ] 抽取公共的名字 -coffee
• [ ] 定义常量(SORT_ASC, SORT_DESC) -coffee
• [ ] 舍去不必要的return -coffee
• [ ] 优先使用angular内置的函数(angular.isString() ...) -coffee
• [ ] coffee的模板语法 -coffee
• [ ] comments参考coffee style guide -coffee
• [ ] 依赖注入过长的格式（grunt annotate）-issue
• [ ] 工具处理依赖注入却没有使用（添加到lint工具中） -issue
• [ ] 空函数应该删掉,比如broadcast编辑页controller中的"vm.changeGenderItems"（待确认） -coffee
• [ ] 对class的操作方式应该保持一致.在broadcast的编辑页里既有用"ng-class", 又有地方用了jQuery- [ ] 的"addClass", "removeClass" -coffee
• [ ] html中添加comment的格式(begin, end)，去除无用的注释掉的comment -html
• [ ] class不要使用原子类 -html -css
• [ ] 尽量使用语义话的html标签 -html

---

• [x] 不要使用无意义的缩写（包括国际化的key） -coffee
• [ ] 小图标尽量使用background-image，可以使用before,after伪类或者实体的标签 -html -css
• [ ] partials和styles文件结构应该保持一致 -html -css
• [ ] 页面中不要有太多的逻辑，还是在coffee中把要显示的数据format好 -html
• [ ] 之后页面中只写组件的layout的样式 -css
• [ ] scss文件最好不要使用！important -css
• [x] 注释，if，for，while上方需要有空行 -coffee
• [ ] 讨论一个方法的最大行数定多少 -issue
• [ ] 考虑抽取baseController（changePage, ChangeSize) -issue
• [x] 统一用for...in... -coffee
• [x] 全局变量写在states里 -coffee
• [x] vm上只允许绑定跟显示有关的变量 -coffee
• [ ] 判断空的几个标准形式 -issue
• [ ] 梳理一个词汇表(vm后的变量分类) -issue
• [ ] 定义resources的grunt task，在模块内做替换。再写个脚本查询扩展模块里引用核心模块resources的地方 -issue