代码规范化

代码规范化:结构规范,命名规范,注释规范

1.结构规范

层次结构清晰,控制类都放控制层,service接口和service实现类都放服务层,数据操作都放mapper,实体类都放Entity,单元测试放在Test文件夹下或放在你要测试的类后面。


一个结构清晰的例子

2.命名规范

对包的命名,小写英文
对类的命名,每个单词首字母都大写,驼峰命名,并都已包结尾结尾
类中的对象,小写英文
方法的命名,首字母小写,后面单词首字母大写,驼峰
同时,命名要有迹可循,不能含糊其次
上图也是一个命名规范的图例

3.注释规范

先上代码

    /**
     * 每个用户只能领同一个发出者发出的一个红包(count())
     * @param luckymoney
     * @return int 有几行记录被改变
     */
    @Override
    public int updateLuckyMoneySingleProducerLimitUseSQLCount(Luckymoney luckymoney) {
        /**
         * 根据红包id查看用户所选择的红包信息
         */
        Luckymoney verify = luckyMoneyMapper.findLuckyMoneyInfoById(luckymoney.getId());
        if (verify == null) {
            log.info("红包id为{}的红包不存在", luckymoney.getId());
            return 0;
        }else
        /**
         * 判断他选择的红包是否已经被领取
         */
            if (verify.getConsumer() == null) {
                /**
                 * 查找符合双条件的红包集合
                 */
                luckymoney.setProducer(verify.getProducer());
                int result = luckyMoneyMapper.countRowNumberByProducerAndConsumer(luckymoney);
                /**
                 * 判断符合条件的result集合中的行数
                 */
                if (result == 0) {
                    int updateRowCount = luckyMoneyMapper.updateLuckyMoneyInfo(luckymoney);
                    if (updateRowCount == 1) {
                        Luckymoney lookLuckyMoneySituation = luckyMoneyMapper.findLuckyMoneyInfoById(luckymoney.getId());
                        log.info("红包领取成功,你领的红包情况是{}", lookLuckyMoneySituation);
                        return updateRowCount;
                    } else
                        log.info("你要领取的红包可能已经被删掉");
                    return updateRowCount;
                } else
                    log.info("领取失败,你已经领过他发的红包了");
                return 0;
            } else
                log.info("领取失败,你所选择的红包已经被{}领取了", verify.getConsumer());
        return 0;
    }

1.写清楚这个方法是干什么的(使用聚合函数count()完成每个用户只能领同一个发出者发出的一个红包的方法)
2.写清楚入参,需要传入什么参数(要传入对象 luckymoney)
3.写清楚返回值,这个方法返回什么(得到int型的有几行记录被改变)
4.在一些复杂代码上进行注释,解释你下面的代码是干什么的。

你可能感兴趣的:(代码规范化)