目的
本规范制定旨在规范项目的开发流程,提高软件开发质量和效率,降低开发成本和风险。该规范包括但不限于以下几个方面:
项目管理
- 包括项目计划、需求分析、设计、开发、测试、发布等环节,以及项目进度、质量和风险管理等方面
- 项目计划管理:制定项目计划,包括确定项目目标、范围、进度、成本、质量、风险、资源等方面的内容,以确保项目按时、按质、按量完成。
- 项目需求管理:对项目需求进行规范化管理,包括需求收集、分析、确认、变更控制等方面的内容,以确保项目需求满足用户需求和项目目标。
- 项目范围管理:明确项目的目标、范围和限制,制定项目计划和时间表,以确保项目能够按时完成并满足客户需求。
- 项目组织管理:确定项目组织结构、职责和权限等,确保项目团队能够高效协作,达成项目目标。
- 项目执行管理:按照项目计划和时间表,执行项目工作,包括需求分析、设计、开发、测试、上线等各个环节。
- 项目进度管理:对项目进度进行规范化管理,包括进度计划、进度控制、进度监督等方面的内容,以确保项目按时完成。
- 项目质量管理:对项目质量进行规范化管理,包括质量计划、质量控制、质量保证等方面的内容,以确保项目交付的产品符合质量标准和用户需求。
- 项目风险管理:对项目风险进行规范化管理,包括风险识别、风险评估、风险应对等方面的内容,以确保项目风险得到有效控制。
- 项目变更管理:对项目变更进行规范化管理,包括变更控制、变更评估、变更记录等方面的内容,以确保项目变更得到有效控制和管理。
技术规范
包括java编程语言代码规范、注释规范、命名规范、异常处理规范等方面,旨在保证代码的可读性、可维护性和可扩展性。
代码规范
方法和类的长度
为便于阅读和理解,单个函数的有效代码长度当尽量控制在 100 行以内(不包括注释行),当一个功能模块过大时往往造成阅读困难,因此当使用子函数等将相应功能抽取出来,这也有利于提高代码的重用度。
单个类也不宜过大,当出现此类情况时当将相应功能的代码重构到其他类中,通过组合等方式来调用,建议单个类的长度包括注释行不超过1500行。尽量避免使用大类和长方法。
间隔问题
类、方法及功能块间等应以空行相隔,以增加可读性,但不得有无规则的大片空行。操作符两端应当各空一个字符以增加可读性。相应独立的功能模块之间可使用注释行间隔,并标明相应内容。
控制语句
判断中如有常量,则应将常量置于判断式的右侧。尽量不使用三目条件判断。所有if语句必须用{}包括起来,即便是只有一句。
循环调节
循环中必须有终止循环的条件或语句,避免死循环。当在for语句的初始化或更新子句中使用逗号时,避免因使用三个以上变量,而导致复杂度提高。若需要,可以在for循环之前(为初始化子句)或for循环末尾(为更新子句)使用单独的语句。因为循环条件在每次循环中多会执行一次,故尽量避免在其中调用耗时或费资源的操作,比较一下两种循环的差异: