团队作业（三）：确定分工
团队作业（三）：确定分工
团队的编码规范和编码原则
命名
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 | 杨璟旭 | 讨论 |
这周事情比较多，没能完成老师布置的所有任务。
借鉴：https://blog.csdn.net/m0_37714245/article/details/82773459
