Alpha代码规范、冲刺任务与计划

Alpha代码规范、冲刺任务与计划

团队名称: 云打印
作业要求: Alpha代码规范、冲刺任务与计划
作业目标:代码规范、冲刺任务与计划。

团队队员

队员学号	队员姓名	个人博客地址	备注
221600412	陈宇	http://www.cnblogs.com/chenyuu/	队长
221600411	陈迎仁	https://www.cnblogs.com/yinen/
221600409	蔡森林	https://www.cnblogs.com/csl8013/
221600401	陈诗娴	https://www.cnblogs.com/orangepoem/
221600408	蔡鸿键	https://www.cnblogs.com/jichiwoyaochi/

---

代码规范

后端采用Springboot编写 java代码规范我一直是用阿里云java开发手册上的要求。（有些浏览器可能不支持pdf在线预览，那就只能直接下载,我正常使用的都是Google浏览器）
阿里巴巴Java开发手册纪念版.pdf在线预览

代码规范参考阿里巴巴Java开发手册纪念版：

一、命名风格

【强制】代码中的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束。
反例：_name / name / $name / name_ / name$ / name
【强制】代码中的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。
说明：正确的英文拼写和语法可以让阅读者易于理解，避免歧义。注意，即使纯拼音命名方式也要避免采用。国际通用的名称，可视同英文。
反例：DaZhePromotion [打折] / getPingfenByName() [评分] / int 某变量 = 3
【强制】类名使用 UpperCamelCase 风格，但以下情形例外：DO / BO / DTO / VO / AO / PO / UID 等。
正例：MarcoPolo / UserDO / XmlService / TcpUdpDeal / TaPromotion
反例：macroPolo / UserDo / XMLService / TCPUDPDeal / TAPromotion
【强制】方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格，必须遵从驼峰形式。
正例： localValue / getHttpMessage() / inputUserId
【强制】常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长。
正例：MAX_STOCK_COUNT
反例：MAX_COUNT
【强制】抽象类命名使用 Abstract 或 Base 开头；异常类命名使用 Exception 结尾；测试类 命名以它要测试的类的名称开始，以 Test 结尾。
【强制】包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式，但是类名如果有复数含义，类名可以使用复数形式。
正例：应用工具类包名为 com.alibaba.ai.core.util、类名为 MessageUtils（此规则参考 spring 的框架结构）
【强制】杜绝完全不规范的缩写，避免望文不知义。
反例：AbstractClass“缩写”命名成AbsClass；condition“缩写”命名成 condi，此类随 意缩写严重降低了代码的可阅读性。
【推荐】为了达到代码自解释的目标，任何自定义编程元素在命名时，使用尽量完整的单词组合来表达其意。
正例：在 JDK 中，表达原子更新的类名为：AtomicReferenceFieldUpdater。
反例：变量 int a 的随意命名方式。

二、代码格式

【强制】大括号的使用约定。如果是大括号内为空，则简洁地写成{}即可，不需要换行；如果是非空代码块则：
左大括号前不换行。
左大括号后换行。
右大括号前换行。
右大括号后还有 else 等代码则不换行；表示终止的右大括号后必须换行。
【强制】if/for/while/switch/do 等保留字与括号之间都必须加空格。
【强制】采用 4 个空格缩进，禁止使用 tab 字符。

三、注释规约

【强制】类、类属性、类方法的注释必须使用 Javadoc 规范，使用/**内容/格式，不得使用 // xxx 方式。
说明：在 IDE 编辑窗口中，Javadoc 方式会提示相关注释，生成 Javadoc 可以正确输出相应注释；在 IDE 中，工程调用方法时，不进入方法即可悬浮提示方法、参数、返回值的意义，提高阅读效率。
【强制】所有的抽象方法（包括接口中的方法）必须要用 Javadoc 注释、除了返回值、参数、异常说明外，还必须指出该方法做什么事情，实现什么功能。
说明：对子类的实现要求，或者调用注意事项，请一并说明。
【强制】所有的类都必须添加创建者和创建日期。
【强制】方法内部单行注释，在被注释语句上方另起一行，使用//注释。方法内部多行注释 使用/ */注释，注意与代码对齐。
【强制】所有的枚举类型字段必须要有注释，说明每个数据项的用途。
【推荐】与其“半吊子”英文来注释，不如用中文注释把问题说清楚。专有名词与关键字保持英文原文即可。
反例：“TCP连接超时”解释成“传输控制协议连接超时”，理解反而费脑筋。
【推荐】代码修改的同时，注释也要进行相应的修改，尤其是参数、返回值、异常、核心逻辑等的修改。
说明：代码与注释更新不同步，就像路网与导航软件更新不同步一样，如果导航软件严重滞后，就失去了导航的意义。

前端代码规范

1、变量名称用先小写后大写命名，如：maxStudy
2、先后端数据变量一致使用后端命名方式
3、若在小范围的命名变量中使用三个字母的命名，如：msg
4、避免使用不易理解的数字，用有意义的标识来替代。涉及物理状态或者含有物理意义的常量，不应直接使用数字，必须用有意义的静态变量来代替。
5、不要使用难懂的技巧性很高的语句，除非很有必要时。说明：高技巧语句不等于高效率的程序，实际上程序的效率关键在于算法。
6、css、js语句代码后加“ ; ”断句
7、使用空行来分割逻辑

冲刺任务与计划（含冲刺总结）

任务	内容	时间
第一天	阅读代码规范，安装相应的环境	4.24
第二天	完成微信小程序登录授权	4.25
第三天	完成微信小程序上传文件	4.26
第四天	完成后台计算页数	4.27
第五天	学习微信支付接口	4.28
第六天	完成小程序微信支付接口	4.29
第七天	后端和小程序和微信支付对接	4.30
第八天	完成商家端接单和查看订单	5.1
第九天	整合代码，测试程序	5.2
第十天	发布Alpha版本程序	5.3
第十一天	发布一篇冲刺总结随笔，描述项目预期计划、现实进展、过程体会、组员分工及在Alpha阶段的工作量比例、下阶段展望。	5.4

转载于:https://www.cnblogs.com/CY-947205926/p/10762654.html