JAVA注解篇

Java程序中Doc(文档)注释详解 许多人写代码时总不喜欢写注释,每个程序员如此,嘿嘿,我也一样 不过,话说回来,该写还是要写哦!没人会喜欢一个不写注释的程序员,当然,也没有一个喜欢写注释的程序员,今天,我们就来说说Java注释之一——Doc注释 我们知道,Java支持 3 种注释,分别是单行注释、多行注释和文档注释,我们来看看他们的样子 //单行注释 /* 多行注释 */ /** *@... *.... *文档注释 */ 可能许多萌新不明白,写了这些注释有什么用呢? 其实是因为初学者的代码量少,没有注释也能快速查找、修改. 阅读详情

目录

Java将注解抽取到doc文件中:

 JDK中预定义的一些注解

4.在程序中使用(解析)注解:

一、基本概念

注解概念:

应用于说明程序,给计算机看的。

注解定义:

注解也叫做元数据,一种代码级别的说明。他是JDK1.5之后版本引入的一个特性,与类,接口,枚举是在同一个层次。它可以声明在包,类,字段,方法,局部变量,方法参数等的前面,用来对这些数据进行说明。

概念描述:

1.JDK1.5之后新特性

2.说明程序的

3.使用注解:@注解名称

作用分类:

1.编写文档:通过代码里标识的元数据(注解)生成文档【生成文档doc文档】

2.代码分析:通过代码里标识的元数据(注解)对代码进行分析【使用反射】

3.编译检查:通过代码里标识的元数据(注解)让编译器能够实现基本的编译检查【Override(如toString方法的重写)】

Java将注解抽取到doc文件中:

先定义一个类,在类中定义方法  并且在类中写入注解(快捷键:/**enter)

package cn.annotation;
/*
* 注解javadoc演示
*
* @author tangxiaocong
* @since 1.5
* */
public class AnnoDemo1 {

    /*
    * 注解
    * 注解来描述一些信息
    * 这些注解可以被抽取但Java doc文档中
    *
    *
    *
    * */
    /**
     * 计算两数之和
     * @param a 整数
     * @param b 整数
     * @return 返回两数之和
     */
    public  int add(int a,int b)
{
    return a+b;
}






}

类中注解会被抽取到doc文件中

先新建一个文件夹,把java文件粘贴进入此文件

为了方便后边的抽取,把包给 注释 或 删除

打开命令行窗口

打开当前当前文件夹输入javadoc AnnoDemo1.java

打开之后会在“新建文件夹”下边生成大量html文件

JDK中预定义的一些注解

1.@override       :检测被该注解标注的方法是否是继承自父类(接口)的

2.@Deprecated   :该注解标注的内容,表示已经过时(已经有新方法替代它)

3.@SuppressWarnings  :压制警告(需要传递参数一般为all)

eg:@SuppressWarnings("all")
package cn.annotation;
@SuppressWarnings("all")
public class AnnoDemo2 {
    @Override
    public String toString() {
        return super.toString();
    }
    @Deprecated
    public void show1()
    {
        //有缺陷
    }
    public void show2()
    {
        //替代show1
    }


}

自定义注解

格式:

元注解

public @interface 注解名称{

}

本质:

先编译(javac)生成字节码文件  再反编译(javap)生成一下:

public interface cn.annotation.MyAnno extends java.lang.annotation.Annotation {

}

注解本质上就是一个接口,该接口默认继承Annotation接口

属性:

接口中可以定义的成员方法(接口中的抽象方法)

要求:

1.属性的返回值类型:

基本数据类型

String

枚举(enum)

注解

以上类型的数组

(不允许void)

2.定义了属性,在使用时需要给属性赋值

(1)如果定义属性时,使用default关键字给属性默认初始化值,则使用注解时,可以不进行属性的赋值。

(2)如果只有一个属性需要赋值,并且属性的名称是value,则value可以省略,直接定义值即可。

(3)数组赋值时,值使用{}包裹。如果数组中只有一个值,则{}省略

3.元注解

用于描述注解的注解

eg:

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.SOURCE)
public @interface Override {
}

@Target:表示注解能够作用的位置 @Target(ElementType.METHOD) 

ElementType取值:(ElementType是数组)

METHOD:表示可以作用在方法上

TYPE:表示可以作用在类上

FIELD:表示可以作用于成员变量上

package cn.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Target;

//表示该注解MyAnno3只能作用于类上
@Target(value={ElementType.TYPE,ElementType.METHOD,ElementType.FIELD})
  public @interface MyAnno3 {



}

@Retention:描述注解被保留的阶段, @Retention(RetentionPolicy.SOURCE)

RUNTIME:表示当前被描述的注解,会保留到class字节码文件中,并被JVM读取到

CLASS:表示当前被描述的注解,会保留到class字节码文件中,但是不会被读取到

SOURCE:表示当前被描述的注解,只会在源码中出现,不会保留到class文件中

package cn.annotation;

import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;

//表示该注解MyAnno3只能作用于类上
//@Target(value={ElementType.TYPE,ElementType.METHOD,ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnno3 {



}

@Documented:描述注解是否被抽取到api文档中

表示当前被描述的注解会被抽取到Javadoc的文档中

在不加@Documented的情况下生成的API文档:

@Inherited:描述注解是否被子类继承

4.在程序中使用(解析)注解:

获取注解中定义的属性值

1.获取注解定义的位置的对象(Class,Method,Field)

2.获取指定的注解

getAnnotation(Class)

3.调用注解中的抽象方法获取配置的属性值

前提:

不能改变该类的任何代码,可以创建任意类的对象,可以执行任意方法

步骤:

<strong>1.解析注解

        1.1 获取该类的字节码文件对象</strong>

Class<ReflectTest> reflectTestClass = ReflectTest.class;

<strong>2 .获取上边注解对象(其实就是在内存中生成一个该注解接口的子类实现对象)</strong>
pro annotation = reflectTestClass.getAnnotation(pro.class);

相当于重写注解接口中的方法     因为返回值为String    重写后会return 回来

3.调用注解对象中定义的抽象方法,获取返回值

String s = annotation.className();
String s1 = annotation.methodName();
package cn.annotation;
@pro(className = "cn.annotation.Demo1",methodName = "show")
public class ReflectTest {
    public static void main(String[] args) {
            //1.解析注解
        //1.1 获取该类的字节码文件对象
        Class<ReflectTest> reflectTestClass = ReflectTest.class;
        //2 获取上边注解对象
        //其实就是在内存中生成一个该注解接口的子类实现对象
        pro annotation = reflectTestClass.getAnnotation(pro.class);//
        //3.调用注解对象中定义的抽象方法,获取返回值
        String s = annotation.className();
        String s1 = annotation.methodName();
        System.out.println(s);
        System.out.println(s1);

    }
}
Java 文档注释 作者</a>* @author <a href="mail to: *******@******.com" rel="nofollow">作者公司信息: ************公司 *********部 阅读详情

相关推荐

【Java】枚举与注解篇

枚举类型和注解类型是 Java 语言中非常强大且实用的特性,它们各自有着独特的设计目的和应用场景。枚举类型通过提供类型安全的常量集合,使代码更加清晰、易读和健壮;注解类型则通过为代码添加元数据信息,实现了代码的灵活配置和功能扩展。在实际开发中,合理运用枚举类型和注解类型可以提高代码的可维护性、可扩展性和开发效率。开发者可以根据具体的需求,将枚举类型和注解类型结合使用,创造出更加高效、优雅的 Java 程序。

m0_72516377的博客 1266

Java AOP 通过注解实现切面及通过注解改变返回值

面向切面编程、通过注解实现AOP

weixin_43958683的博客 5671

国产数据库迁移必看:达梦到ES的CDC方案优化全记录(含完整代码)

本文详细记录了从达梦数据库到Elasticsearch的CDC方案优化全过程,涵盖触发器方案局限性、Debezium架构优势及完整代码实现。通过Flink集成和性能调优,实现毫秒级延迟同步,显著降低数据库负载,为国产数据库迁移提供可落地的技术方案。

weixin_29079671的博客 500

Java Doc--文档注释--写法使用

原文网址: 简介 说明 本文介绍Java Doc(文档注释)的用法。 官网 https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html Java Doc注解 标签 描述 示例 @author 标识一个类的作者 @author description @deprecated 指名一个过期的类或成员 @deprecated description {@docRoot} 指明当前文档根目录的路径 Directory Path

m0_67394360的博客 1585

SAP PCE私有云MM02修改物料主数据基本单位报错

当前发现只有改为AAAADL(无量纲)单位时会报错,其他的正常。一开始以为配置的ISO码换算有问题,对配置排查后,排除配置问题。最后发现是PCE当前版本的原因,需要打上NOTE。SAP PCE私有云在没有库存和业务单据的情况下,MM02修改物料主数据基本单位报错“EA CPZP MK000000000000:PCS 不可转换为”,详见截图。点击【显示错误】,提示EA CPZP MK000000000000:PCS 不可转换为。从SAP FOR ME下载NOTE 3531359,链接。

dingqing86的专栏 526

SpringBoot文件上传实战:MultipartFile重复读取的3种方法(附避坑指南)

本文详细介绍了SpringBoot中处理MultipartFile重复读取的3种实用方法,包括字节数组缓存法、临时文件法和流重置法,并提供了避坑指南和性能优化技巧。特别适合需要多次读取上传文件内容的开发者,帮助解决InputStream流只能读取一次的问题。

weixin_28710999的博客 399

返回参数自动拼接图片前缀地址

import cn.hutool.core.lang.PatternPool; import cn.hutool.core.util.ReUtil; import cn.hutool.core.util.StrUtil; import com.fasterxml.jackson.core.JsonGenerator; import com.fasterxml.jackson.databind.JsonSerializer; import com.fasterxml.jackson.databind.Ser.

qq_40016813的博客 725

MATPOWER的安装详细教程

MATPOWER的安装包实际为一个程序包,安装教程很简单,详见本文。

半个月亮Zz的博客 3万+

【总结篇】Java注解总结

注解在 Java5 提出的一个特性,写法简单。注解是 Java 中的 metadate(元数据),其实就是代码里的 ”特殊标记“,这些标记可以在编译、类加载、运行时被读取,并执行相应的处理。通过使用注解,程序员可以在不改变原有逻辑的情况下,在源文件中嵌入一些补充信息。 注解 可以像修饰符一样被使用,可用于修饰包、类、构造器、方法、成员变量、参数、局部变量的声明。 使用 注解 时要在前面加 `@` 符号,并把该注解当成一个修饰符使用。

小异常的博客 623

GhidrAssist:AI驱动的逆向工程助手实战指南

逆向工程是分析软件内部工作原理、理解二进制代码逻辑的关键技术,广泛应用于软件安全、恶意代码分析和漏洞挖掘等领域。其核心原理在于通过反编译、控制流与数据流分析等手段,将机器码还原为可理解的高级语言表示。传统逆向分析高度依赖人工经验,面对海量代码时效率低下且易出错。随着大语言模型(LLM)技术的发展,其强大的代码理解与推理能力为自动化逆向分析提供了新的可能。通过将LLM与成熟的逆向工程框架(如Ghidra)相结合,可以构建智能辅助系统,实现代码意图的自动解释、变量/函数的智能重命名以及潜在漏洞模式的辅助识别,从

weixin_42547335的博客 596

【笔记篇】Davinci Configurator BswM模块

AUTOSAR BSWM模块配置介绍

weixin_47571898的博客 1535

Java注解篇

1.注解的定义 Java 注解(Annotation)又称 Java 标注,是 JDK5.0 引入的一种注释机制。 2.注解的作用 作用:可对程序作出解释,可被其他程序读取。 3.注解的格式 格式:@注解名(一些参数值) 例:@SuppressWarnings(value=“unchecked”) 4.内置注解和元注解 4.1.内置注解 注解信息 作用 @Override 重写 @Deprecated 不鼓励使用,已废弃 @SuppressWarnings(value = “值”

m0_37775931的博客 174

Qt c++ llama.cpp 运行 LLaMA-3-8B 中文对话机器人(多模态输入)

助手:

寒寒豆豆软件公司的博客 224

Java基础:注解篇

目录概念分类按照来源分类按照作用分类JDK注解使用JDK注解示例自定义注解自定义注解格式注解中抽象方法约束自定义注解的本质元注解@Target@Retention@Documented@Inherited完整的自定义注解示例 概念 注解(Annotation),也叫元数据。一种代码级别的说明。它是JDK1.5及以后版本引入的一个特性,与类、接口、枚举是在同一个层次。它可以声明在包、类、字段、方法、...

zhangyuanshuai的博客 234

2026年数学建模国赛E题SEM广告投放策略 论文

结果显示,全年展现量为 22,580,381 次,点击量为 834,815 次,消费额为 1,425,949.79 元,整体 CTR 为 3.70%,CPC 为 1.71 元,CPA 为 16.71 元。对于 2025 年 2 月 1-8 日和 8 月 1-8 日,在总预算保持 51,164.93 元不变的情况下,预计注册量由 3,985.09 次提高到 4,580.04 次,提升 14.93%,CPA 从 12.84 元下降到 11.17 元。第二,关键词分类使用中位数和分位指标,对极端消费具有稳健性。

YOLO 165

Statistics and Machine Learning Toolbox

Statistics and Machine Learning Toolbox(带书签),MATLAB统计学习工具

Java篇 - 深入了解注解

注解在我们平时的开发中到处可见,无论是Javaee还是android开发,如JUnit,ButterKnife,Dagger2,Retrofit,EventBus,android.support.annotation。 今天我来带大家整理一下注解,做到知其然更知其所以然。   目录: 注解的概述 Java预置的注解 元注解 注解的属性 注解与反射(android permiss...

u014294681的博客 2857

华为的C语言编程规范.pdf

华为技术有限公司内部技术规范。本规范制定了编写C语言程序的基本原则、规则和建议。从代码的清晰、简洁、可测试、安全、程序效率、可移植各个方面对C语言编程作出了具体指导。

【Java 基础篇】Java 注解详解

注解是一种标记在 Java 类、方法、字段和其他程序元素上的特殊标签。这些标签提供了有关元素的额外信息,通常以注解的方式存储在 Java 源代码中。注解通常不影响程序的运行,但可以在编译时、运行时或通过工具进行处理。Java 注解以符号开头,后跟注解的名称,如@Override等。注解可以有元素,元素以键值对的形式存储信息。// 类的内容在上面的示例中,@Author是一个自定义注解,具有两个元素name和date,它们存储了有关类MyClass的信息。

繁依Fanyi的博客 1822

VB摄像头监控

该VB模块可对摄像头捕获的画面进行录像等,可在创建的窗口进行控制

贝叶斯统计 [韦来生编]

贝叶斯(Bayes)统计是近几十年来迅速发展起来的数理统计的一个重要分支。贝叶斯方法与经典统计方法的主要不同之处是进行统计推断时除了利用样本信息外,还要利用参数的先验信息,因此可以提高统计推断或统计决策的效果。它在经济、金融、生物、医学、自然科学和社会科学等许多领域具有广泛的应用。贝叶斯方法的研究已渗透到了统计学的几乎所有领域。作者在给中国科学技术大学概率论与数理统计专业本科生开设的“数理统计”课程中有一章专门讲授“贝叶斯方法和统计决策理论”,近十年来也给中国科学技术大学概率统计专业研究生开设过几次“贝叶斯分析”课。本书是在对过去讲稿的内容作了适当的增减和调整的基础上完成的。  本书共分六章。第1章是绪论,介绍了贝叶斯统计的若干基本概念,同时对必要的数理统计的基础知识有重点地作了回顾。第二章介绍了确定先验分布的若干可供选择的方法。第三章介绍了几类常见统计模型参数的后验分布的主要结果和计算方法。第四章和第五章分别介绍了“贝叶斯统计推断”和“贝叶斯统计决策”的内容。第六章介绍了贝叶斯统计计算的若干方法,包括蒙特卡洛方法和马尔可夫链蒙特卡洛(MCMC)方法以及相关统计软件的简介。本书的每一章附右大量的例题和习题,书末附有常用的几个表格和部分习题解答供读者查用。  大约可在54学时内讲授本书的第1章至第六章的主要内容,教师可根据学时需要选讲本书第1章至第六章的部分内容。书中标“*”号的章节可略去不讲,留给读者作为阅读材料。第六章例题中的R代码和部分例题的数据文件等可从作者个人主页下载。  作者在编写本书的过程中参考了J.O.Berger教授的《统计决策论及贝叶斯分析》和茆诗松教授编写的《贝叶斯统计》等书中的一些内容,以及《贝叶斯分析》一书中由张伟平博士编写的有关贝叶斯统计计算的一些内容。在此表示衷心感谢。  本书编写准备过程中,中国科学技术大学统计与金融系的几个研究生帮助完成了本书部分中文的录入和排版,作者对他们的辛勤工作表示真诚的感谢。高等教育出版社为本书的出版给予了大力支持。在此一并致谢。

Java注解简介篇

本文详细介绍java注解是什么,如何声明java注解,如何解析java注解。最后介绍JDK提供的几大基本注解,使用这些基本注解可自定义用户注解。

理查德的博客 557

Java 注解篇:@AliasFor

在 Spring 框架中,注解的使用非常广泛。为了增强注解的灵活性和可组合性,Spring 引入了一个非常有用的元注解 —— @AliasFor。它主要用于为注解属性之间建立别名关系,使得在使用注解时可以更自由地配置参数,同时也为注解组合与继承提供了强大支持。

x² 2316

JAVA-注解篇

JAVA-注解篇一、什么是注解?二、注解有什么用?三、注解的语法?四 、注解可以使用在那些位置?五、java中常用的注解?六、注解中的元注解?六、自定义注解的示例?七、如何使用自定义注解?八、如何使用自定义注解?九、如何使用反射获取注解? 一、什么是注解? 注解 Annotation也一种引用类型数据,在编译后同样会生成.class文件,注解可以述程序所需要的信息, 二、注解有什么用? 注解可以减轻眼样板“代码”的负担,使用注解可以使代码干净易懂,可以在编译期对数据进行检查、验证和测试。 三、注解的语法?

qq_46489900的博客 171

java注解篇

JDK1.5之后引入的一个特性,于接口、枚举、类是同一个层次。可以对包、类、字段、方法、参数、局部变量进行说明、注释。

程序员一博 306

java进阶之注解篇

文章目录注解基本语法定义注解元注解编写注解处理器 注解 注解(也被称为元数据)为我们在代码中添加信息提供了一种形式化的方式,使我 们可以在稍后的某个时刻更容易的使用这些数据。 注解在一定程度上是把元数据和源代码文件结合在一起的趋势所激发的,而不是保 存在外部文档。这同样是对像C# 语言对于Java 语言特性压力的一种回应。 注解是Java 5 所引入的众多语言变化之一。它们提供了Java 无法表达的但是你需 要完整表述程序所需的信息。因此,注解使得我们可以以编译器验证的格式存储程序的 额外信息。注解可以生成

zeng_jun_yv的博客 387

Java 注解 实现篇

概述 注解分为元注解和标记注解,元注解实现自定义注解,标记注解帮助检查或者减少代码。元注解有四个分别为,documented:表示注解会包含在 java 文档中、inherited:表示子类也含有该注解、retention:表明注解的留存节点(java级 - 被编译器抛弃,class级 - 被虚拟机抛弃,运行级 - 通过反射以运行且保留)、target:表示注解在什么地方使用。关键字为,inte

稚枭天卓 584

Java 注解篇:@PostConstruct

是 Java 中用于标记初始化方法的注解。它常用于依赖注入框架(如 Spring)中,表示一个方法应该在所有依赖注入完成之后被自动调用。其主要用途是对 Bean 初始化后执行一些自定义的初始化操作。本文将详细讲解的原理、使用场景及最佳实践。是 Java 中非常实用的注解,尤其是在 Spring 等框架中,它使得开发者可以方便地在 Bean 初始化后执行额外的操作。合理使用可以帮助开发者更好地管理 Bean 生命周期、提高代码的可维护性和清晰度。

x² 8130

java 注解篇

什么是注解 // 注解是代码标记 格式 @注解名称(属性名称=属性值,属性名称=属性值,…) // 注解 可以在类 方法 属性上 都可以加注解 // 注解的目的: 简化xml配置 // @Component (把普通实例化到spring容器中,相当于配置文件中的 <bean id="" class=""/>) // @Service // 一般用在 实现层 // @Controller // 一般用在控制层 // @Repository // 用在 DAO层 // 以上注解 都..

Json的知识梦工厂 408
上一篇: Java并发之AbstractQueuedSynchronizer(AQS)详解
下一篇: 一些可以显著提高大型 Java 项目启动速度的尝试
javaYY_
博客等级 码龄4年 148粉丝 69原创
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付:10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值