凡口项目编程规范手册

1、命名问题

变量命名规范：

• 采用驼峰命名法（首字母小写）： 比如 textName;
• 静态常量全部用大写：比如 PI；
• 尽量做到见名知意

方法、函数命名规范

• 方法名首字母小写，并采用驼峰命名法命名

类、接口的命名规范

• 类名大写，并采用驼峰命名法命名

包的命名规范

• 包命名一律采用小写
• 总包名命名一般规则：比如com.hnu.fk
• 子包命名以层次划分即可：比如domain、controller

总原则：能通过阿里编程规范插件的检查即可视为正确，可以参考阿里编程规范手册。

2、注释问题

类、接口的注释模板文件

/**
 * 说明: 
 * <br>
 * @author ${USER}
 * <br>
 * 邮箱: ${EMAIL}
 * <br>
 * 日期: ${DATE}
 * <br>
 * 版本: 1.0
 */

类、接口的注释规范

package com.zscdumin.springboot.bean;
import org.springframework.beans.factory.annotation.Value;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.Id;
import javax.validation.constraints.NotNull;
/**
 * 说明: 图书类实体
 * <br>
 * @author ZSCDumin
 * <br>
 * 邮箱: 2712220318@qq.com
 * <br>
 * 日期: 2018/8/2
 * <br>
 * 版本: 1.0
 */
@Entity
public class User {
    /**
     * 编号
     */
    @Id
    @GeneratedValue
    private Integer id;
    /**
     * 姓名
     */
    private String name;
    /**
     * 性别
     */
    @Value("True")
    private boolean sex;
    /**
     * 年龄
     */
    @Value("20")
    private Integer age;
    /**
     * 无参构造函数
     */
    public User() {
    }
    /**
     * 全参数构造函数
     *
     * @param id   Integer
     * @param name String
     * @param sex  Boolean
     * @param age  Integer
     */
    public User(Integer id, String name, boolean sex, Integer age) {
        this.id = id;
        this.name = name;
        this.sex = sex;
        this.age = age;
    }
    /**
     * 获取用户Id
     *
     * @return Id Integer
     */
    public Integer getId() {
        return id;
    }
    /**
     * 设置用户Id
     *
     * @param id Integer
     */
    public void setId(Integer id) {
        this.id = id;
    }
    /**
     * 获取用户姓名
     *
     * @return name String
     */
    public String getName() {
        return name;
    }
    /**
     * 设置用户姓名
     *
     * @param name String
     */
    public void setName(String name) {
        this.name = name;
    }
    /**
     * 获取用户性别
     *
     * @return sex Boolean
     */
    public boolean isSex() {
        return sex;
    }
    /**
     * 设置用户性别
     *
     * @param sex Boolean
     */
    public void setSex(boolean sex) {
        this.sex = sex;
    }
    /**
     * 获取用户年龄
     *
     * @return age Integer
     */
    public Integer getAge() {
        return age;
    }
    /**
     * 设置用户年龄
     *
     * @param age Integer
     */
    public void setAge(Integer age) {
        this.age = age;
    }
}

【注】若在写复杂的业务逻辑处理时，需要将处理过程详细说明在函数内部，以便他人阅读代码。

3、编码规范

一律采用UTF-8编码

4、接口文档标准

采用Swagger2自动生成接口文档

• 新增采用PUT方式提交
• 修改采用POST方式提交
• 查询采用GET方式提交
• 删除采用DELETE方式提交

5、JavaDoc生成规范

解决中文乱码问题

• Intellij idea 在Tools > Generate JavaDoc里的other commandline arguments添加： -encoding UTF-8