凡事预则立
作者:互联网
这个作业属于哪个课程 | https://edu.cnblogs.com/campus/zswxy/computer-science-class3-2018 |
---|---|
这个作业要求在哪里 | https://edu.cnblogs.com/campus/zswxy/computer-science-class3-2018/homework/12066 |
这个作业的目标 | 项目冲刺 |
小组的组号和队名 | 憨批工作室 |
小组的队长姓名 | 雷玮鑫 |
冲刺的时间计划安排
时间:6月7日~6月13日
- 6月7日:开始项目准备工作
- 6月7号:冲刺动员
- 6月8日~6月12日:代码编写和测试
- 6月13日:总结
思考和总结
项目到了现在遇到了很多之前没有设想到的问题,所以我们要好好总结之前的错误和走过的弯路,争取在后面解决好这些问题,完成好这个项目。
团队代码规范
一、命名风格
代码中的命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束。
- 反例: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
二、代码格式 - 大括号的使用约定。如果是大括号内为空,则简洁地写成{}即可,不需要换行;如果是非空代码块则:
左大括号前不换行。
左大括号后换行。
右大括号前换行。
右大括号后还有 else 等代码则不换行;表示终止的右大括号后必须换行。
三、注释规约 - 类、类属性、类方法的注释必须使用 Javadoc 规范,使用/**内容*/格式,不得使用 // xxx 方式。
说明:在 IDE 编辑窗口中,Javadoc 方式会提示相关注释,生成 Javadoc 可以正确输出相应注释;在 IDE 中,工程调用方法时,不进入方法即可悬浮提示方法、参数、返回值的意义,提高阅读效率。 - 所有的抽象方法(包括接口中的方法)必须要用 Javadoc 注释、除了返回值、参数、异常说明外,还必须指出该方法做什么事情,实现什么功能。
说明:对子类的实现要求,或者调用注意事项,请一并说明。
团队项目的github仓库
标签:name,换行,凡事预则立,代码,Javadoc,注释,大括号 来源: https://www.cnblogs.com/hanpioffice/p/14880821.html