java作业分工_团队作业（三）：确定分工

团队作业(三)：确定分工

团队的编码规范和编码原则

命名

1.1通用命名

代表完全相同意义的命名必须相同；如果一个变量在不同的地方代表的意义完全相同，那么不管是用在前端、后端、数据库表名、字段名等，请务必起相同的名字；

良好的命名应该能顾名思义，不需要解释；

# good

int(student_count)# 学生数量

# bad

int(count) # 学生数量

谨慎使用缩略词，不常见的缩略词会大大降低代码的可读性；避免缩写，除非该缩写是众所周知的，如HTML、URL等；

命名应该是简短且有意义的。

1.2编程语言中的命名

类名、接口名以UpperCamelCase风格编写；

类名使用名词或名词短语；

class IndexHandler():

pass

接口使用RESTfull设计分格；

测试类的命名以它要测试的类的名称开始，以Test结束；

方法名以lowerCamelCase风格编写

def function():

pass

建议方法名使用动宾短语，也可以使用动词；

常量名以CONSTANT_CASE风格编写；

减少代码中的硬编码，代码中不允许出现直接硬编码的字面常量，尤其是重复出现的硬编码；你需要做的是将硬编码定义成常量；如果常量在一个类中用到，则在类中定义，否则可以在公共类中定义常量。

常量必须用常量修饰符修饰；

注释

2.1代码注释

单行注释使用 #，多行注释使用”“” chars “”“

块注释与其周围的代码在同一缩进级别；

禁止没有意义的注释；很多时候，判断一句注释是不是废话还跟开发者水平有关；

注释一般不包含语言本身的语法、语言内置的API的说明、第三方类库(如Spring等)某个函数的用法的说明；不懂的去看相应的开发文档；

对整段代码进行注释说明，而不是逐行注释；

只进行必要的注释，注释不是越多越好；

对编写的比较Trick的代码做注释，方便他人理解。

2.2文档注释

文档注释描述Java的类、接口、构造器，方法，以及字段(field)。每个文档注释都会被置于注释定界符/**...*/之中，一个注释对应一个类、接口或成员。该注释应位于声明之前，javadoc是j2sdk里面一个非常重要的工具，如果你按照规范在Java的源代码里面写好注释的话，那么它就可以生成相应的文档，便于开发者察看，Myeclipse生成步骤，点击菜单栏的Project，选择generate

javadoc，下一步即可。

javadoc参数定义：

@author 对类的说明标明开发该类模块的作者

@version 对类的说明标明该类模块的版本

@see 对类、属性、方法的说明参考转向，也就是相关主题

@param 对方法的说明对方法中某参数的说明

@return 对方法的说明对方法返回值的说明

@exception 对方法的说明对方法可能抛出的异常进行说明

学号

姓名

负责工作

20175307

高士淳

讨论，文案

20175323

鞠欣余

讨论

20175330

杨璟旭

讨论

java作业分工_团队作业（三）：确定分工相关推荐

java客户服务器程序预约口罩_团队作业（二）：Github实训：口罩预约
这个作业要求在哪里这个作业的目标使用Github进行团队协作其他参考文献 <构建之法> Part 1 关于此次作业 (1)组员职责分工 221701436:组织小组参与讨论分工,测试 ...
python编程大赛队名_团队作业1——团队展示选题
这个作业属于哪个课程这个作业要求在哪里这个作业的目标团队展示&选题一.队名 gdut_名媛二.队员姓名学号郭裕霖(队长) 3118005361 丁科文 3118005359 刘 ...
2018软工实践_团队作业_1
如果记忆是一个罐头的话,我希望这一罐罐头不会过期----<重庆森林> 404 Note Found Team 如果记忆是一个备忘录的话,别说了,它不会过期----<404 Note ...
java 虚拟打印机_打印作业提交给打印机，使用虚拟打印机但不是真正的打印机 . Java的...
我是java新手,在java中遇到打印服务问题 . 我正在尝试用Java创建一个桌面应用程序,它安装在系统中,调用api,返回结果并打印 . 仅当我们从api获得结果时才调用打印服务 . 所以我的问题 ...
java在线作业系统_在线作业系统论文
摘要随着计算机技术的发展,越来越多的行业实现了管理的信息化和自动化.教育行业也不例外.为了满足现代教学的需求,进一步加强老师和学生的交流,同时改变过去传统的作业批改方式, 设计了基于B/S 模式的 ...
python大赛对名_团队作业1——团队展示选题
团队展示: 1.队名: KKlist 队名含义:因为做的个人计划这个项目其实是关于todolist这个范畴的.项目名称要简洁并能表达出实际含义.List就是我们项目的核心-一个待办事项提醒的功能实现. ...
计算机毕业设计java+ssm理论课_考勤,作业,签到管理系统(源码+系统+mysql数据库+Lw文档）
项目介绍本理论课管理系统采用目前最流行的ssm框架和eclipse编辑器.mysql数据库设计并实现的 .主要包括登录模块.课程信息管理模块.考勤信息管理模块.成绩管理模块.和退出模块等多个模块本 ...
java水球游戏_团队趣味游戏-《水球大战》操作说明及注意事项-水上拓展项目-七维卓越...
水球大战发布人:拓展训练发表时间:2021-1-26 一.项目简介 water balloons fight (水球大战) ,是国外著名夏日流行活动,于高校及城市开阔场地,使用装满清水的小型气球来 ...
java cqrs架构_团队开发框架实战—CQRS架构
团队开发框架实战-CQRS架构 CQRS架构图 261851438603372.jpg CQRS架构图.png 什么是CQRS? 这里只通过Udi Dahan的<Clarified CQRS&g ...

java作业分工_团队作业（三）：确定分工

java作业分工_团队作业（三）：确定分工相关推荐

最新文章

热门文章