IDEA java 代码注释的一些设置

首先 注释的分类

    /**
    * @description: 这一块是文档注释
    * @email: 2996139769@qq.com
    * @date: 2022/6/10 17:56
    */
    @Override
    public ResponseResult updateUserInfo(User user) {
        // save(user) 这是普通的单行注释
        updateById(user);
        return ResponseResult.okResult();
    }
    /* 多行注释用，也可以单行 */
    
    /*
    // TODO 特殊形式
    @Override
    public ResponseResult updateUser(User user) {
        return null;
    }*/

上面三种注释方法学过 java 的应该都会用。这里介绍一种不一样的注释(源于SpringBoot前后端分离项目实战-博客项目-Java项目_哔哩哔哩_bilibili)。

这个博主项目讲的特别好，循循渐进。我是学了两三遍SpringBoot后做的这个项目。

下面说这种不一样的注释  ----节选代码如下

public ResponseResult xxxxx(String parms) {
        // region queryWrapper
        // 查询对应文章得根评论
        LambdaQueryWrapper<Comment> queryWrapper = new LambdaQueryWrapper<>();
        // 根评论 yyy-1
        queryWrapper.eq(Entity::getYyy,-1);
        // 评论类型
        queryWrapper.eq(Entity::getXxx,2);
        // endregion

        // 分页查询
        Page<Comment> page = new Page(pageNum,pageSize);
        page(page,queryWrapper);
       
        return null;
    }

效果图如下！

 是不是很像一个方法被IDEA折叠了？ 是的。一些看上去没有营养的代码就这样折叠起来叭！

代码颜色的设置

其中：Comments 里面是注释代码，选中不同的标签如Text、Markup 再点击右边那个十六进制的数字可以自选颜色。

注释代码模板

 这一块我不太熟练，可以自行搜索。关键字 IDEA 注释 模板