ICode9

精准搜索请尝试: 精确搜索
首页 > 其他分享> 文章详细

心满意组——代码规范与计划

2022-05-19 23:32:25  阅读:129  来源: 互联网

标签:函数 代码 规范 满意 注释 信息 模块


这个作业属于哪个课程 至诚软工实践F班
这个作业要求在哪里 第五次团队作业:项目冲刺
这个作业的目标 提交一份关于团队的代码规范以及本次冲刺计划的随笔,计划要求包括冲刺阶段的任务计划以及预期目标等
其他参考文献 阿里巴巴Java开发手册华为内部代码规范

一、代码规范

1.命名规范

  • 所有命名规则必须遵循以下规则:名称只能由字母、数字、下划线、$符号组成,不能以数字开头,名称不能使用JAVA中的关键字。所有命名遵从驼峰命名法。

  • 绝对不允许在命名时出现中文,尽可能的少用拼音性的命名、简明,易读,无二义性。

  • 包里面不能嵌套包,因为包和包是同级的,用包这个概念就是为了区分类

  • 包名最好将域名反过来写防止冲突。

  • 类名首字母大写,如果类名由多个单词组成,每个单词的首字母都要大写。如:public class MyFirstClass{}

2.注释规范

  • 对类,接口,公用和保护类变量使用javadoc注释,必须包括描述,参数,返回值,异常的说明。

  • 应用于类、方法、构造函数的注释立即出现在文档块之后,并且每个注释都列在自己的一行上或上方。

  • 注释尽可能使用//,对于所有的 Javadoc 的注释使用/***/,而临时对代码块进行注释应尽量使用/**/。

  • 修改相关代码后对应注释信息需同步更新且注释内容避免歧义。

  • 代码中至少包含15%的注释,注释内容尽量选择中文。

3.排版规范

  • 相对独立的程序块之间必须加空行,例:两个方法之间、方法内的局部变量和方法的第一条语句之间、块注释或单行注释之前、一个方法内的两个逻辑段之间。

  • 程序块要采用缩进风格写,缩进时请使用Tab键,严禁使用空格来进行缩进,也可使用Eclipse源代码的格式化功能完成代码的缩进排版。

  • 在一些算术运算符、逻辑运算符等需在前后在空格。

  • 函数参数或单行代码长度过长时需要进行适当的划分。

4.变量结构规范

  • 公共变量是增大模块间耦合的原因之一,故应减少没必要的公共变量以降低模块间的耦合度。

  • 仔细定义并明确公共变量的含义、作用、取值范围及公共变量间的关系。

  • 明确公共变量与操作此公共变量的函数或过程的关系,如访问、修改及创建等。

5.可读性规范

  • 符合阅读习惯,例如:判断长度时,if (length >= 10)优于if (10 <= length)。

  • 避免深嵌套,过多的嵌套层次会使代码变得难以阅读和跟踪。

  • 避免代码行水平过长是一种良好的变成习惯。

  • 避免使用不易理解的命名,使任何命名都能顾名思义。

6.函数、过程规范

  • 一个函数仅完成一件功能。

  • 函数的规模尽量限制在200行以内。

  • 不要设计多用途面面俱到的函数,多功能集于一身的函数,很可能使函数的理解、测试、维护等变得困难。

  • 避免设计多参数函数,不使用的参数从接口中去掉。

  • 尽量不要编写依赖于其他函数内部实现的函数。

  • 函数的返回值要清楚、明了,让使用者不容易忽视错误情况。

7.程序效率规范

  • 在保证软件系统的正确性、稳定性、可读性及可测性的前提下,提高代码效率。

  • 尽量减少代码冗余,提升整体效率。

  • 在多重循环中,应将最忙的循环放在最内层。

8.测试规范

  • 清理、整理或优化后的代码要经过审查及测试。

  • 仔细分析设计测试用例、尽可能覆盖更多的情况。

  • 仔细处理代码的边界情况。

二、预期计划

规划日期 任务进度及安排
第 1 天 规范代码及分配任务、明确队员负责的内容
第 2 天 前端界面设计初步完成、后端加强学习各自技术、类包结构设计
第 3 天 前端界面设计完成、后端思路梳理完毕开始进行
第 4 天 前后端数据库等基本配置映射设计
第 5 天 后端各模块接口设计
第 6 天 后端基本函数设计
第 7 天 完成后端各模块功能
第 8 天 完成后端各模块功能
第 9 天 完成后端各模块功能
第 10 天 进行前后端初次链接映射跳转
第 11 天 系统建成能成功运行
第 12 天 完成程序测试交付

三、预期目标

预期各模块达成目标如下所示:

序号 功能点 功能实现
1 登录 用户登录及管理员登录
2 进货明细模块 分页显示、增删改对应信息、搜索特定信息
3 进货登记模块 分页显示、增删改对应信息、搜索特定信息
4 退货登记模块 分页显示、增删改对应信息、搜索特定信息
5 库存管理模块 分页显示、增删改对应信息、搜索特定信息
6 供应商管理模块 分页显示、增删改对应信息、搜索特定信息
7 管理员管理模块 分页显示、增删改对应信息、搜索特定信息

标签:函数,代码,规范,满意,注释,信息,模块
来源: https://www.cnblogs.com/sweetcat-w/p/16290713.html

本站声明: 1. iCode9 技术分享网(下文简称本站)提供的所有内容,仅供技术学习、探讨和分享;
2. 关于本站的所有留言、评论、转载及引用,纯属内容发起人的个人观点,与本站观点和立场无关;
3. 关于本站的所有言论和文字,纯属内容发起人的个人观点,与本站观点和立场无关;
4. 本站文章均是网友提供,不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属;如您发现该文章侵犯了您的权益,可联系我们第一时间进行删除;
5. 本站为非盈利性的个人网站,所有内容不会用来进行牟利,也不会利用任何形式的广告来间接获益,纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。

专注分享技术,共同学习,共同进步。侵权联系[81616952@qq.com]

Copyright (C)ICode9.com, All Rights Reserved.

ICode9版权所有