项目开发要注意的相关事宜

• Git部分
  • 前端后端各一个仓库（一共两个仓库）
  • 各小组人员仅在自己的分支下进行开发
  • 开发完一个功能并测试无误后提交至主分支，项目管理员进行审核
  • 项目中遇到的各种问题尽量使用Github上的issues进行提交（能给自己的Github加活跃度）
  • 如若提交了不能正常运行的代码，可以尝试使用版本回退
• 前端部分
  • 使用Vue进行组件化开发，应在开发之前规划好哪些单独提取成组件，哪些直接集成
  • 规划好目录结构，使用英文一目了然
  • 使用次数较多的函数考虑封装到同一个js文件
  • 网络请求最起码做一层简单封装（即把axios封装，具体封装看百度）
• 后端部分
  • 重要的常量写进配置文件
  • 严格按照接口文档进行开发
  • 代码注释要齐全，下面是一个注释模板的例子，大家可以通过配置自己的IDE进行自动化生成

package com.pang.prototype;

/**
 * 学生类 （类的作用，这行是注释在类定义上面的）
 *
 * @author pang (类的作者)
 * @ClassName: Student (类名)
 * @Package com.pang.prototype （类所在的包）
 * @date 2019/10/7 13:37 (创建类的时间)
 */
public class Student {
    /**
     * 用户名(这种注释应该在字段上，内容是该字段是什么作用)
     */
    private String studentName = "小胖儿";

    /**
     * 获取用户名（这种注释应该在方法上，这一行是来叙述方法的作用的）
     *
     * @return java.lang.String 得到的用户名 （这一行是来表示返回值为什么类型和做什么用的）
     * @author pang （方法的作者）
     * @date 2019/10/13 （编写方法的时间）
     */
    public String getStudentName() {
        return studentName;
    }

    /**
     * 设置用户名 （这种注释应该在方法上，这一行是来叙述方法的作用的）
     *
     * @param studentName 要设置成的用户名 （这一行是用来表示参数以及参数作用的，多个参数可以列成多行）
     * @return com.pang.prototype.Student 得到学生实体 （这一行是来表示返回值为什么类型和做什么用的）
     * @author pang （方法的作者）
     * @date 2019/10/13 编写方法的时间）
     */
    public Student setStudentName(String studentName) {
        this.studentName = studentName;
        return this;
    }
}