@Documented注解的作用

水深无声 2024-04-06 11:42 23阅读 0赞

`@Documented`和`@Deprecated`注解长得有点像，`@Deprecated`是用来标注某个类或者方法不建议再继续使用，`@Documented`只能用在注解上，如果一个注解@B，被`@Documented`标注，那么被@B修饰的类，生成文档时，会显示@B。如果@B没有被`@Documented`标注，最终生成的文档中就不会显示@B。这里的生成文档指的JavaDoc文档！

> `@Deprecated`注解基本上所有框架自定义的注解都会添加，所谓javadoc其实就是JDK给我们提供的一个生成文档的工具！

![在这里插入图片描述][3bd1abc029014bb3ae4b2397456ecd0a.png]

**使用示例如下：**

@Documented
    public @interface DocumentedMy {
        
        String value() default "这是一个自定义类";
    }
    @DocumentedMy
    public class MyTest1 {
        
        public String getStr() {
        
            return "123";
        }
    }

> 生成javadoc文档有两种方式，一种是直接基于javadoc命令，一种是ide提供的！当然实际在开发当中我们很少会使用这个文档！除非我们要开源某个框架什么的才会用到！

**通过ider生成javadoc文档：**

1.点击项目当中的任意包

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NjEwMTgzOQ_size_16_color_FFFFFF_t_60][]

2.点击生成JavaDoc

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NjEwMTgzOQ_size_16_color_FFFFFF_t_60 1][]

3.指定生成位置

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NjEwMTgzOQ_size_16_color_FFFFFF_t_60 2][]

4.点击index.html

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NjEwMTgzOQ_size_16_color_FFFFFF_t_60 3][]

5.查看我们使用自定义注解的类，会发现他文档上面会展示这个自定义注解！

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NjEwMTgzOQ_size_16_color_FFFFFF_t_60 4][]

假如把自定义注解当中的@Documented去掉，然后使用该自定义注解的类，生成的文档就会不显示该注解！

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NjEwMTgzOQ_size_16_color_FFFFFF_t_60 5][]

**@Deprecated：被标注过的方法，调用就会出现横线，表示不建议再继续使用，但是还能用！**

![在这里插入图片描述][d6a37eb64ac64fd3aa0871565ed5a998.png]

/**
     * 测试Deprecated注解
     * @author Administrator
     */
    public class DeprecatedDemoTest {
        
        public static void main(String[]args) {
        
            // 使用DeprecatedClass里声明被过时的方法
            DeprecatedClass.DeprecatedMethod();
        }
    }
    
    class DeprecatedClass {
        
        @Deprecated
        public static void DeprecatedMethod() {
        
        }
    }

[3bd1abc029014bb3ae4b2397456ecd0a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/9eda086ab2934dd89df72ddf58a44f92.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NjEwMTgzOQ_size_16_color_FFFFFF_t_60]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/e45993a4572e49b28ceba174e02cea2f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NjEwMTgzOQ_size_16_color_FFFFFF_t_60 1]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/8111aeb03a464a67b6aae6debc4d6c35.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NjEwMTgzOQ_size_16_color_FFFFFF_t_60 2]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/9460c2d4c405437aa8c6a0a4a8158444.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NjEwMTgzOQ_size_16_color_FFFFFF_t_60 3]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/b3f00be825e44167be5dc4e00cd8148c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NjEwMTgzOQ_size_16_color_FFFFFF_t_60 4]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/322efdf7975d46328c0da38905af8d99.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NjEwMTgzOQ_size_16_color_FFFFFF_t_60 5]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/73d64c1b1183489c9833e1979a315813.png
[d6a37eb64ac64fd3aa0871565ed5a998.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/83c50647ac1342cea6aaa0e22e9a3a2a.png