「java注释」java注释的快捷键
本篇文章给大家谈谈java注释<>，以及java注释的快捷键对应的知识点，希望对各位有所帮助，不要忘了收藏本站喔。
本文目录一览：
- 1、Java中文档注释各字段的含义是什么？例如author表示作者，para表示参数等
- 2、java开发中常用的注解有哪些
- 3、java中如何自动生成注释
- 4、java注释里的这些标记分别是什么意思？
Java中文档注释各字段的含义是什么？例如author表示作者，para表示参数等
常用Java注释标签（Java comment
tags）
@author 作者
适用范围：文件、类、方法
（*多个作者使用多个@author标签标识，java
doc中显示按输入时间顺序罗列。）
例：*
@author Leo. Yao
@param 输入参数的名称 说明
适用范围：方法
例：* @param str
the String用来存放输出信息。
@return 输出参数说明
适用范围：方法
例： *
@return codetrue/code执行成功;
* codefalse/code执行失败.
@since
JDK版本
用于标识编译该文件所需要的JDK环境。
适用范围：文件、类
例： * @since
JDK1.6
@version 版本号
用于标识注释对象的版本号
适用范围：文件、类、方法
例： * @version 1.0
@see 链接目标
表示参考。会在java 文档中生成一个超链接，链接到参考的类容。使用中的感觉是@see不需要包路径，对我这种懒人比较喜欢，相对{@link
}这种既要加大括号，有需要包路径，我还是选择偷懒，当然你要是不介意使用import导入要link的类，那就可以达到@see的效果，所以总体来说，还是选择@see，当然两个在特殊场合下还是用法不一样的
用法：
@see
#field
@see #Constructor(Type,
Type...)
@see #Constructor(Type id, Type
id...)
@see #method(Type,
Type,...)
@see #method(Type id, Type,
id...)
@see
Class
@see
Class#field
@see Class#Constructor(Type,
Type...)
@see Class#Constructor(Type id,
Type id)
@see Class#method(Type,
Type,...)
@see Class#method(Type id, Type
id,...)
@see
package.Class
@see
package.Class#field
@see
package.Class#Constructor(Type, Type...)
@see
package.Class#Constructor(Type id, Type id)
@see package.Class#method(Type,
Type,...)
@see package.Class#method(Type
id, Type, id)
@see
package
@throws 异常
标识出方法可能抛出的异常
适用范围：方法
例： * @throws IOException If an input or output
exception occurred
@deprecated 解释
标识对象过期
适用范围：文件、类、方法
@link 链接地址
链接到一个目标，用法类似@see。但常放在注释的解释中形如{@link …}
例：
/**
* @deprecated As of JDK 1.1,
replaced by
* {@link
#setBounds(int,int,int,int)}
*/
java开发中常用的注解有哪些
Java 注解全面解析，学习java做一个java工程师不但待遇高，而且前途无可限量。为什么这样说呢？因为java程序语言作为最流行的计算机开发语言之一，几乎所有的系统、软件、app、网页等都是需要用到java的。
1.基本语法
注解定义看起来很像接口的定义。事实上，与其他任何接口一样，注解也将会编译成class文件。
@Target(ElementType.Method)
@Retention(RetentionPolicy.RUNTIME)
public @interface Test {}
除了@符号以外，@Test的定义很像一个空的接口。定义注解时，需要一些元注解（meta－annotation），如@Target和@Retention
@Target用来定义注解将应用于什么地方（如一个方法或者一个域）
@Retention用来定义注解在哪一个级别可用，在源代码中（source），类文件中（class）或者运行时（runtime）
在注解中，一般都会包含一些元素以表示某些值。当分析处理注解时，程序可以利用这些值。没有元素的注解称为标记注解（marker annotation）
四种元注解，元注解专职负责注解其他的注解，所以这四种注解的Target值都是ElementType.ANNOTATION_TYPE
注解 说明
@Target 表示该注解可以用在什么地方，由ElementType枚举定义
CONSTRUCTOR：构造器的声明
FIELD：域声明（包括enum实例）
LOCAL_VARIABLE：局部变量声明
METHOD：方法声明
PACKAGE：包声明
PARAMETER：参数声明
TYPE：类、接口（包括注解类型）或enum声明
ANNOTATION_TYPE：注解声明（应用于另一个注解上）
TYPE_PARAMETER：类型参数声明（1.8新加入）
TYPE_USE：类型使用声明（1.8新加入）
PS：当注解未指定Target值时，此注解可以使用任何元素之上，就是上面的类型
@Retention 表示需要在什么级别保存该注解信息，由RetentionPolicy枚举定义
SOURCE：注解将被编译器丢弃（该类型的注解信息只会保留在源码里，源码经过编译后，注解信息会被丢弃，不会保留在编译好的class文件里）
CLASS：注解在class文件中可用，但会被VM丢弃（该类型的注解信息会保留在源码里和class文件里，在执行的时候，不会加载到虚拟机（JVM）中）
RUNTIME：VM将在运行期也保留注解信息，因此可以通过反射机制读取注解的信息（源码、class文件和执行的时候都有注解的信息）
PS：当注解未定义Retention值时，默认值是CLASS
@Documented 表示注解会被包含在javaapi文档中
@Inherited 允许子类继承父类的注解
2. 注解元素
– 注解元素可用的类型如下：
– 所有基本类型（int,float,boolean,byte,double,char,long,short）
– String
– Class
– enum
– Annotation
– 以上类型的数组
如果使用了其他类型，那编译器就会报错。也不允许使用任何包装类型。注解也可以作为元素的类型，也就是注解可以嵌套。
元素的修饰符，只能用public或default。
– 默认值限制
编译器对元素的默认值有些过分挑剔。首先，元素不能有不确定的值。也就是说，元素必须要么具有默认值，要么在使用注解时提供元素的值。
其次，对于非基本类型的元素，无论是在源代码中声明，还是在注解接口中定义默认值，都不能以null作为值。这就是限制，这就造成处理器很难表现一个元素的存在或缺失状态，因为每个注解的声明中，所有的元素都存在，并且都具有相应的值。为了绕开这个限制，只能定义一些特殊的值，例如空字符串或负数，表示某个元素不存在。
@Target(ElementType.Method)
@Retention(RetentionPolicy.RUNTIME)
public @interface MockNull {
public int id() default -1;
public String description() default “”;
}
3. 快捷方式
何为快捷方式呢？先来看下springMVC中的Controller注解
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Component
public @interface Controller {
String value() default “”;
}
可以看见Target应用于类、接口、注解和枚举上，Retention策略为RUNTIME运行时期，有一个String类型的value元素。平常使用的时候基本都是这样的：
@Controller(“/your/path”)
public class MockController { }
这就是快捷方式，省略了名－值对的这种语法。下面给出详细解释：
注解中定义了名为value的元素，并且在应用该注解的时候，如果该元素是唯一需要赋值的一个元素，那么此时无需使用名－值对的这种语法，而只需在括号内给出value元素所需的值即可。这可以应用于任何合法类型的元素，当然了，这限制了元素名必须为value。
4. JDK1.8注解增强
TYPE_PARAMETER和TYPE_USE
在JDK1.8中ElementType多了两个枚举成员，TYPE_PARAMETER和TYPE_USE，他们都是用来限定哪个类型可以进行注解。举例来说，如果想要对泛型的类型参数进行注解：
public class AnnotationTypeParameter@TestTypeParam T {}
那么，在定义@TestTypeParam时，必须在@Target设置ElementType.TYPE_PARAMETER，表示这个注解可以用来标注类型参数。例如：
@Target(ElementType.TYPE_PARAMETER)
@Retention(RetentionPolicy.RUNTIME)
public @interface TestTypeParam {}
ElementType.TYPE_USE用于标注各种类型，因此上面的例子也可以将TYPE_PARAMETER改为TYPE_USE，一个注解被设置为TYPE_USE，只要是类型名称，都可以进行注解。例如有如下注解定义：
@Target(ElementType.TYPE_USE)
@Retention(RetentionPolicy.RUNTIME)
public @interface Test {}
那么以下的使用注解都是可以的:
List@Test Comparable list1 = new ArrayList();
List? extends Comparable list2 = new ArrayList@Test Comparable();
@Test String text;
text = (@Test String)new Object();
java.util. @Test Scanner console;
console = new java.util.@Test Scanner(System.in);
PS：以上@Test注解都是在类型的右边，要注意区分1.8之前的枚举成员，例如：
@Test java.lang.String text;
在上面这个例子中，显然是在进行text变量标注，所以还使用当前的@Target会编译错误，应该加上ElementType.LOCAL_VARIABLE。
@Repeatable注解
@Repeatable注解是JDK1.8新加入的，从名字意思就可以大概猜出他的意思（可重复的）。可以在同一个位置重复相同的注解。举例：
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface Filter {
String [] value();
}
如下进行注解使用:
@Filter({“/admin”,”/main”})
public class MainFilter { }
换一种风格:
@Filter(“/admin”)
@Filter(“/main”)
public class MainFilter {}
在JDK1.8还没出现之前，没有办法到达这种“风格”，使用1.8，可以如下定义@Filter：
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Repeatable(Filters.class)
public @interface Filter {
String value();
}
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface Filters {
Filter [] value();
}
实际上这是编译器的优化，使用@Repeatable时告诉编译器，使用@Filters来作为收集重复注解的容器，而每个@Filter存储各自指定的字符串值。
JDK1.8在AnnotatedElement接口新增了getDeclaredAnnotationsByType和getAnnotationsByType，在指定@Repeatable的注解时，会寻找重复注解的容器中。相对于，getDeclaredAnnotation和getAnnotation就不会处理@Repeatable注解。举例如下：
@Filter(“/admin”)
@Filter(“/filter”)
public class FilterClass {
public static void main(String[] args) {
ClassFilterClass filterClassClass = FilterClass.class;
Filter[] annotationsByType = filterClassClass.getAnnotationsByType(Filter.class);
if (annotationsByType != null) {
for (Filter filter : annotationsByType) {
System.out.println(filter.value());
}
}
System.out.println(filterClassClass.getAnnotation(Filter.class));
}
}
日志如下:
/admin
/filter
null
望采纳！
java中如何自动生成注释
你说的应该是生成javadoc吧?
最简单方式就是使用命令行, cd到你的项目源代码目录下, 输入如下指令:
javadoc -d docs -subpackages com.yourpackage
其中-d docs指定了生成的javadoc在相对目录docs下, -subpackages com.yourpackage指定了你要被生成javadoc的源代码包.
JAVADOC是官方提供的一种生成注释文档的工具, 他的用法如下:
用法: javadoc [options] [packagenames] [sourcefiles] [@files]
-overview file 从 HTML 文件读取概览文档
-public 仅显示 public 类和成员
-protected 显示 protected/public 类和成员 (默认值)
-package 显示 package/protected/public 类和成员
-private 显示所有类和成员
-help 显示命令行选项并退出
-doclet class 通过替代 doclet 生成输出
-docletpath path 指定查找 doclet 类文件的位置
-sourcepath pathlist 指定查找源文件的位置
-classpath pathlist 指定查找用户类文件的位置
-cp pathlist 指定查找用户类文件的位置
-exclude pkglist 指定要排除的程序包列表
-subpackages subpkglist 指定要递归加载的子程序包
-breakiterator 计算带有 BreakIterator 的第一个语句
-bootclasspath pathlist 覆盖由引导类加载器所加载的
类文件的位置
-source release 提供与指定发行版的源兼容性
-extdirs dirlist 覆盖所安装扩展的位置
-verbose 输出有关 Javadoc 正在执行的操作的信息
-locale name 要使用的区域设置, 例如 en_US 或 en_US_WIN
-encoding name 源文件编码名称
-quiet 不显示状态消息
-Jflag 直接将 flag 传递到运行时系统
-X 输出非标准选项的提要
通过标准 doclet 提供:
-d directory 输出文件的目标目录
-use 创建类和程序包用法页面
-version 包含 @version 段
-author 包含 @author 段
-docfilessubdirs 递归复制文档文件子目录
-splitindex 将索引分为每个字母对应一个文件
-windowtitle text 文档的浏览器窗口标题
-doctitle html-code 包含概览页面的标题
-header html-code 包含每个页面的页眉文本
-footer html-code 包含每个页面的页脚文本
-top html-code 包含每个页面的顶部文本
-bottom html-code 包含每个页面的底部文本
-link url 创建指向位于 url 的 javadoc 输出的链接
-linkoffline url url2 利用位于 url2 的程序包列表链接至位于 url 的文档
-excludedocfilessubdir name1:.. 排除具有给定名称的所有文档文件子目录。
-group name p1:p2.. 在概览页面中, 将指定的程序包分组
-nocomment 不生成说明和标记, 只生成声明。
-nodeprecated 不包含 @deprecated 信息
-noqualifier name1:name2:... 输出中不包括指定限定符的列表。
-nosince 不包含 @since 信息
-notimestamp 不包含隐藏时间戳
-nodeprecatedlist 不生成已过时的列表
-notree 不生成类分层结构
-noindex 不生成索引
-nohelp 不生成帮助链接
-nonavbar 不生成导航栏
-serialwarn 生成有关 @serial 标记的警告
-tag name:locations:header 指定单个参数定制标记
-taglet 要注册的 Taglet 的全限定名称
-tagletpath Taglet 的路径
-charset charset 用于跨平台查看生成的文档的字符集。
-helpfile file 包含帮助链接所链接到的文件
-linksource 以 HTML 格式生成源文件
-sourcetab tab length 指定源中每个制表符占据的空格数
-keywords 使程序包, 类和成员信息附带 HTML 元标记
-stylesheetfile path 用于更改生成文档的样式的文件
-docencoding name 指定输出的字符编码
」java注释的快捷键">
java注释里的这些标记分别是什么意思？
方法/步骤
java注释，总共有3种注释方法。
1、注释一行（在eclipse里的快捷键是：crtl+/）。快捷键按一下注释，再按一下，取消注释。
//内容
//内容
2、注释多行、块注释（在eclipse里的快捷键是：crtl+shift+/）。快捷键按一下注释，再按一下，不能取消注释。只能人为的删除。
/*内容
内容
内容*/
3、文档注释（在eclipse里的快捷键是：/**+enter）。快捷键按一下注释。仅这注释方法可以写入javadoc文档
/** 内容
*内容
*内容
*/
4、javadoc注释标签语法的一些说明。（你可以输入@，在加alt+/（补全键））
@author 对类的说明--标明开发该类模块的作者
@version 对类的说明--标明该类模块的版本
@param 对方法的说明--方法中某参数的说明
@return 对方法的说明--方法返回值的说明
@exception 对方法的说明--方法可能抛出的异常的说明
注释的一些要求。
注释内容要简单、明了、含义准确，防止注释的多义性，错误的注释不但无益反而有害。
END
注意事项
注释内容是不被编辑的内容，只是解释说明
注释，为了更方便的阅读
每次单行注释、多行注释，要选中要注释的内容
java注释<>的介绍就聊到这里吧，感谢你花时间阅读本站内容，更多关于java注释的快捷键、java注释<>的信息别忘了在本站进行查找喔。