如何在java程序中添加注释

1、单行(single-line)--短注释：//…… 单独行注释：在代码中单起一行注释， 注滑皮核释前最好有一行空行，并与其后的代信掘码具有一样的缩进层级。如果单行无法完成，则应采用块注释。 注释格式：/* 注释内容 */ 行头注释：在代码行的开头进行注释。主要为了使该行代码失去意义。 注释格式：// 注释内容 行尾注释：尾端(trailing)--极短的注释，在代码行的行尾进行注释。握祥一般与代码行后空8（至少4）个格，所有注释必须对齐。 注释格式：代码 + 8（至少4）个空格 + // 注释内容

目前创新互联公司已为1000+的企业提供了网站建设、域名、网页空间、网站托管维护、企业网站设计、东风网站维护等服务，公司将坚持客户导向、应用为本的策略，正道将秉承"和谐、参与、激情"的文化，与客户和合作伙伴齐心协力一起成长，共同发展。

2、块(block)--块注释：/*……*/ 注释若干行，通常用于提供文件、方法、数据结构等的意义与用途的说明，或者算法的描述。一般位于一个文件或者一个方法的前面，起到引导的作用，也可以根据需要放在合适的位置。这种域注释不会出现在HTML报告中。注释格式通常写成： /* * 注释内容 */

3、文档注释：/**……*/ 注释若干行，并写入javadoc文档。每个文档注释都会被置于注释定界符 /**......*/ ...

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 注解都有哪些东西？

Java注解相当于对类或者方法或者变量额外的注族举或释（标识）。以下是转载

-------------------------------------------------------

Annotation是Java5、6只后的新特征（中文称之为注解），并且越来越多的得到了应用，比如Spring、Hibernate3、Struts2、iBatis3、JPA、JUnit等等都得到了广泛应用，通过使用注解，代码的灵活性大大提高。

这些都是使用别人定义的注解，一般注解的使用都是在一些基础框架或者类库中来定义的，因此很少见过有人自己去写一个注解出来并使用在程序中，因此注解的使用常常给人感觉很神秘，这就为你揭开注解的面纱。

注解的神秘之处在于：通过类似注释的方式，可以控制程序的一些行为，运兆伍行时的状态，可以为成员赋值，做配置信息等等，与常规编码思维大相径庭。

只用别人定义好的注解是搞不懂这些问题的，要想真正知道注解内部的秘密，要自己定义注解，然后在程序中获取注解信息，拿到注解信息后，就可以为我所用了答厅。

下面我简单演示下三类注解的用法：类注解、方法注解、字段（也称之域）注解的定义与适用，并看看如何获取注解的信息。

一、定义注解

package lavasoft.anntest;

import java.lang.annotation.ElementType;

import java.lang.annotation.Retention;

import java.lang.annotation.RetentionPolicy;

import java.lang.annotation.Target;

/**

* 类注解

*

* @author leizhimin 2009-12-18 14:15:46

*/

@Retention(RetentionPolicy.RUNTIME)

@Target(ElementType.TYPE)

public @interface MyAnnotation4Class {

public String msg();

}

package lavasoft.anntest;

import java.lang.annotation.ElementType;

import java.lang.annotation.Retention;

import java.lang.annotation.RetentionPolicy;

import java.lang.annotation.Target;

/**

* 方法注解

*

* @author leizhimin 2009-12-18 14:16:05

*/

@Retention(RetentionPolicy.RUNTIME)

@Target(ElementType.METHOD)

public @interface MyAnnotation4Method {

public String msg1();

public String msg2();

}

package lavasoft.anntest;

import java.lang.annotation.ElementType;

import java.lang.annotation.Retention;

import java.lang.annotation.RetentionPolicy;

import java.lang.annotation.Target;

/**

* 字段注解

*

* @author leizhimin 2009-12-18 15:23:12

*/

@Retention(RetentionPolicy.RUNTIME)

@Target(ElementType.FIELD)

public @interface MyAnnotation4Field {

public String commont();

public boolean request();

}

二、写一个类，用上这些注解

package lavasoft.anntest;

/**

* 一个普通的Java类

*/

@MyAnnotation4Class(msg = "测试类注解信息")

class TestClass {

@MyAnnotation4Field(commont = "成员变量的注解信息", request = true)

private String testfield;

@MyAnnotation4Method(msg1 = "测试方法注解信息1", msg2 = "测试方法注解信息2")

public void testMethod() {

System.out.println("Hello World！");

}

}

三、测试注解

为了使用注解，需要通过反射获取注解的对象。通过注解对象来操作注解信息。

package lavasoft.anntest;

import java.lang.reflect.Field;

import java.lang.reflect.Method;

/**

* 测试类

*

* @author leizhimin 2009-12-18 14:13:02

*/

public class TestOptAnnotation {

public static void main(String[] args) throws NoSuchMethodException, NoSuchFieldException {

TestClass t = new TestClass();

System.out.println("-----------MyAnnotation4Class注解信息---------");

MyAnnotation4Class an4clazz = t.getClass().getAnnotation(MyAnnotation4Class.class);

System.out.println(an4clazz.msg());

System.out.println("-----------MyAnnotation4Method注解信息---------");

Method method = t.getClass().getMethod("testMethod", new Class[0]);

MyAnnotation4Method an4method = method.getAnnotation(MyAnnotation4Method.class);

System.out.println(an4method.msg1());

System.out.println(an4method.msg2());

System.out.println("-----------MyAnnotation4Field注解信息---------");

Field field = t.getClass().getDeclaredField("testfield");

MyAnnotation4Field an4field = field.getAnnotation(MyAnnotation4Field.class);

System.out.println(an4field点抗 mont());

System.out.println(an4field.request());

}

}

运行结果：

-----------MyAnnotation4Class注解信息---------

测试类注解信息

-----------MyAnnotation4Method注解信息---------

测试方法注解信息1

测试方法注解信息2

-----------MyAnnotation4Field注解信息---------

成员变量的注解信息

true

Process finished with exit code 0

四、总结

看完上面的测试过程，Annotation已经不再神秘了，这里总结下自定义注解的使用方法：

1、自定义注解，注意注解的时空范围，简单说就是注解针对的目标（类、方法、字段），以及注解的时效（运行时、或者源码中有效）。

2、要获取注解的信息，必须通过Java的反射技术来获取Annotation对象，因为你除此之外没有别的获取注解对象的方法。

3、获取了注解对象，就可以调用注解的方法来获取相对应的值了。为基础框架所用。

4、当然，注解也可以没有定义成员，这样注解就成了一个标记符号了。

什么是注释？如何在Java程序中加入注释？

试想一下，一个没有一句注释的程序源码，怎么读，一个程序要上万条代码不可能全部记得住哪一块凯裂咐是什么用，而且一个项目也不会是一个人独自完成，那样效率太低，多人合作就要给别人说明，每盯纯一块是什么用，方便他人使用，方便自己更正，而这些说明文字就是注释，注释不会被执行，不影响运行结果。

Java中代码的注释有三种：

// 注释一行 

/* ...... */ 注释若干行 

/** ...... */ 注释若干行，并写入 javadoc 文档

前源梁两种比较容易理解，至于第三种，你学习Java看的api文档就是javadoc程序根据第三种的注释生成的。

扩展资料

注释就是对代码的解释和说明，其目的是让人们能够更加轻松地了解代码。注释是编写程序时，写程序的人给一个语句、程序段、函数等的解释或提示，能提高程序代码的可读性。

分享文章：java代码注解内容 java注解大全
分享URL：http://scyingshan.cn/article/ddpgegs.html