SpringBoot @Deprecated How to use this method for document annotation is abandoned

For example, I want to tell other engineers that this method has been eliminated, but I see that the @Deprecated annotation only has since() and forRemoval(). Do I need to use Java doc to explain it?

    @Override
    @Deprecated
    public TchCommentClassDetailBO queryCommentClassInfoByCommentId(String commentId) {
        TchCommentClassDetailBO tchCommentClassDetailBO = TchCommentClassModelMapper
                .INSTANCE.convertEntityToBO(tchCommentClassDetailService.queryCommentClassInfoByCommentId(commentId));

        tchCommentClassDetailBO.setCommentModuleScoreBOList(JSONArray.parseArray(String.valueOf(tchCommentClassDetailBO.getWrittenScore()), CommentModuleScoreBO.class));
        tchCommentClassDetailBO.setOralTestScoreBO(JSONObject.parseObject(tchCommentClassDetailBO.getOralTestScore(), CommentModuleScoreBO.class));

        return Optional.ofNullable(tchCommentClassDetailBO)
                .orElse(null);
    }

Comment From: Jzow

I'm thinking about the effect of adding markdown in the @Deprecated annotation, although my idea seems a little abnormal :)

Comment From: mdeinum

The @Deprecated annotation isn't a Spring annotation it is from Java (if you check it is from java.lang). So not sure what Spring (Boot) can add here. If you look at the framework documentation there is an @Deprecated java annotation as well as an @Deprecated javadoc annotation which then provides the documentation.

One example is, for instance, the RmiServiceExporter . Which has both annotations, one for documentation the other for instructing the compiler.

Comment From: bclozel

Closing this, as this is not strictly related to Spring Boot.

Comment From: Jzow

@mdeinum thanks