Java 标记过期方法的注释

最新推荐文章于 2024-04-25 08:31:19 发布

转载最新推荐文章于 2024-04-25 08:31:19 发布 · 5.9k 阅读

Java基础专栏收录该内容

151 篇文章

订阅专栏

本文介绍如何在Java中使用@Deprecated注解标记过期的方法，并提供了详细的示例代码及建议，包括添加描述信息来提高代码可读性。

java标记过期方法

1、只需要在方法的上方添加@Deprecated注解即可。

2、建议同时添加过期的描述信息。即：在方法的注释中添加一个@deprecated的参数描述。

如果不加过期的描述信息，那么使用checkstype插件检查代码会报下面的错
Must include both @java.lang.Deprecated annotation and @deprecated Javadoc tag with description.

3、java代码例子：

    /** 

     * Description:测试方法过期注解 <br> 

     *  

     * @taskId <br> 

     * @param 请求参数req 

     * @return 响应<br> 

     * @deprecated 该方法未被调用过，已废弃使用 

     */ 

    @Deprecated 

    public String test(String req) { 

        return null; 

    }
 1
2
3
4
5
6
7
8
9
10
11
12