本文目录一览:
java方法名前注释问题
Java注解是附加在代码中的一些元信息,用于一些工具在编译、运行时进行解析和使用,起到说明、配置的功能。
注解不会也不能影响代码的实际逻辑,仅仅起到辅助性的作用。包含在 java.lang.annotation 包中。
1、元注解
元注解是指注解的注解。包括 @Retention @Target @Document @Inherited四种。
1.1、@Retention: 定义注解的保留策略
@Retention(RetentionPolicy.SOURCE) //注解仅存在于源码中,在class字节码文件中不包含
@Retention(RetentionPolicy.CLASS) // 默认的保留策略,注解会在class字节码文件中存在,但运行时无法获得,
@Retention(RetentionPolicy.RUNTIME) // 注解会在class字节码文件中存在,在运行时可以通过反射获取到
1.2、@Target:定义注解的作用目标
@Target(ElementType.TYPE) //接口、类、枚举、注解
@Target(ElementType.FIELD) //字段、枚举的常量
@Target(ElementType.METHOD) //方法
@Target(ElementType.PARAMETER) //方法参数
@Target(ElementType.CONSTRUCTOR) //构造函数
@Target(ElementType.LOCAL_VARIABLE)//局部变量
@Target(ElementType.ANNOTATION_TYPE)//注解
@Target(ElementType.PACKAGE) ///包
由以上的源码可以知道,他的elementType 可以有多个,一个注解可以为类的,方法的,字段的等等
1.3、@Document:说明该注解将被包含在javadoc中。
1.4、@Inherited:说明子类可以继承父类中的该注解。
请列出java中的注释
在Java里面主要有三种注释:行注释、段落注释、文档注释
1)行注释:行注释也成为单行注释,行注释使用 “//注释文字”的格式来对某一行的代码进行注释或者加以说明
2)段注释:段注释也成为多行注释,通常是当说明文字比较长的时候的注释方法
3)文档注释:文档注释是Java里面的一个比较厉害的功能,它可以用于注释类、属性、方法等说明,而且通过JDK工具javadoc直接生成相关文档,文档注释的基本格式为“/**...*/”,不仅仅如此,文档注释本身还存在语法
java 文档注释是注释什么的,不是有多行注释了吗?
1、【文档注释】是写在类或者方法的上面的。
文档注释可以用eclipse导出chm格式的帮助文档,拿给其他人用时,方便他人理解。文档注释被调用的方法,当鼠标移到上面时提醒注释内容。
使用文档注释时,需要在开始的 /** 之后,第一行或几行是关于类、变量和方法的主要描述。
之后,可以包含一个或多个何种各样的@ 标签。每一个@标签必须在一个新行的开始或者在一行的开始紧跟星号(*)。多个相同类型的标签应该放成一组。
2、【多行注释】注释的也是方法或类,言下之意就是一次性的将程序中的多行代码注释掉,但多行注释的内容不能用于生成一个开发者文档。
3、【多行注释与文档注释的区别】多行注释的内容不能用于生成一个开发者文档,而文档注释的内容可以生产一个开发者文档。
扩展资料
java常用的文档注释标签
1、@author:标识一个类的作者
实例: @authordescription
2、@deprecated:指名一个过期的类或成员
实例: @deprecateddescription
3、@exception:标志一个类抛出的异常
实例:@exceptionexception-nameexplanation
4、{@inheritDoc}:从直接父类继承的注释
实例:Inheritsacommentfromtheimmediatesurperclass.
5、{@link}:插入一个到另一个主题的链接
实例:{@linknametext}
6、{@linkplain}:插入一个到另一个主题的链接,但是该链接显示纯文本字体
实例:Insertsanin-linelinktoanothertopic.
7、@param:说明一个方法的参数
实例:@paramparameter-nameexplanation
8、@return:说明返回值类型
实例:@returnexplanation
9、@see:指定一个到另一个主题的链接
实例:@seeanchor
10、@serial:说明一个序列化属性
实例:@serialdescription
参考资料:百度百科-java注释