「java注释参数」java注释规范

今天给各位分享java注释参数的知识，其中也会对java注释规范进行解释，如果能碰巧解决你现在面临的问题，别忘了关注本站，现在开始吧！

本文目录一览：

• 1、怎么动态给java注解参数赋值？
• 2、java 文档注释是注释什么的,不是有多行注释了吗?
• 3、java方法名前注释问题
• 4、java 中的几种注释方式
• 5、java里的注解都有哪些？都有什么用处啊？

怎么动态给java注解参数赋值？

动态赋值指的是在配置文件配置好然后在项目中动态读取？如果是这样的话：

1.在xml文件中使用context:property-placeholder location="”/

这种方式可以读取location指定位置对应的文件，引用的话使用${key}可以获取对应的数据

和这种写法相同的还有

bean class=“com.spring….config.PropertyPlaceholderConfigurer”

property name=“locations"

arrayvalue/value/array

/property

bean

这种是用bean来加载配置文件，看起来更直观

2.通过@Value注解读取配置

这种方法也需要预先在xml文件中设定好配置文件的位置

bean id=“prop” class=“org.springframework.beans.factory.config.PropertiesFactoryBean”

property name=“locations”

array

valueclasspath:.properties/value

/array

/property

/bean

之后在java代码里面可以用#{prop.key}来获取对应的数据prop是bean的名字，key是配置文件的键。

3.使用@PropertySource

在springboot中，可以不需要xml文件来设置配置文件，在需要使用配置文件的类名字前加上

@PropertySource(“locations")就可以读取指定位置的配置，在代码中使用@Value注解可以获取这些数据

@Value(value = “${key}”)

4.使用@ConfigurationProperties(prefix=“”)

SpringBoot项目有时候会使用application.yml来存储配置信息，一般情况下这些数据的存储格式是

a:

key1:value1

key2:value2

这种嵌套方式，当然可以多层嵌套

在需要使用配置文件的类上面使用@ConfigurationProperties(prefix=“a”)可以获取a标签下一层所有的配置的键值对。

java 文档注释是注释什么的,不是有多行注释了吗?

1、【文档注释】是写在类或者方法的上面的。

文档注释可以用eclipse导出chm格式的帮助文档，拿给其他人用时，方便他人理解。文档注释被调用的方法，当鼠标移到上面时提醒注释内容。

使用文档注释时，需要在开始的 /** 之后，第一行或几行是关于类、变量和方法的主要描述。

之后，可以包含一个或多个何种各样的@ 标签。每一个@标签必须在一个新行的开始或者在一行的开始紧跟星号(*)。多个相同类型的标签应该放成一组。

2、【多行注释】注释的也是方法或类，言下之意就是一次性的将程序中的多行代码注释掉，但多行注释的内容不能用于生成一个开发者文档。

3、【多行注释与文档注释的区别】多行注释的内容不能用于生成一个开发者文档，而文档注释 的内容可以生产一个开发者文档。

扩展资料

java常用的文档注释标签

1、@author：标识一个类的作者

实例： @author description

2、@deprecated：指名一个过期的类或成员

实例： @deprecated description

3、@exception：标志一个类抛出的异常

实例：@exception exception-name explanation

4、{@inheritDoc}：从直接父类继承的注释

实例：Inherits a comment from the immediate surperclass.

5、{@link}：插入一个到另一个主题的链接

实例：{@link name text}

6、{@linkplain}：插入一个到另一个主题的链接，但是该链接显示纯文本字体

实例：Inserts an in-line link to another topic.

7、@param：说明一个方法的参数

实例：@param parameter-name explanation

8、@return：说明返回值类型

实例：@return explanation

9、@see：指定一个到另一个主题的链接

实例：@see anchor

10、@serial：说明一个序列化属性

实例：@serial description

参考资料：百度百科-java注释

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基础大全301集教中的三种注释方法：

1、单行注释   //注释的内容

2、多行注释  /*......*/

3、/**......*/，这种方式和第二种方式相似。这种格式是为了便于javadoc程序自动生成文档。

下面介绍一下Javadoc的标记：

特别声明：

（1）javadoc针对public类生成注释文档

（2）javadoc只能在public、protected修饰的方法或者属性之上

（3）javadoc注释的格式化：前导*号和HTML标签

（4）javadoc注释要仅靠在类、属性、方法之前

下面主要举例说明第三种注释的应用：

（1）首先编写.java文件

（2）在命令行中执行以下dos命令：

javadoc *.java //根据相应的Java源代码及其说明语句生成HTML文档

//javadoc标记：是@开头的，对javadoc而言，特殊的标记。

（3）在当前目录下就会产生doc文件夹，里面有一系列的.html文件

附上代码：

[java] view plain copy

span style="font-size:18px;"*/

/**javadoc注释的内容

*/

public class Hello{

/**属性上的注释*/

public String name;

/**这是main方法,是程序的入口

*@param args 用户输入参数

*/

public static void main(String[] args){

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

f1();

}

/** 这是第1个方法,其作用是...*/

public static void f1(){

System.out.println("f1()！");

}

}/span

[java] view plain copy

span style="font-size:18px;"import java.io.IOException;

/**javadoc注释内容

*@since 1.0

*@version 1.1

*@author Blue Jey

*br链接到另一个文档{@link Hello},就这些

*see Hello

*/

public class HelloWorld{

/**非public，protected 属性上的注释不生成*/

public String name;

/**这是main方法，是程序的入口

*@param args 用户输入的参数，是数组

*@throws IOException main方法io异常

*/

public static void main(String args[]) throws IOException{

System.out.println("hello World!");

f1();

f2(1);

}

/**这是第一个方法，其作用是....

*@deprecated 从版本1.2开始，不再建议使用此方法

*/

public static void f1(){

System.out.println("fl()!");

}

/**这是第二个方法，其作用是....

*@return 返回是否OK

*@param i 输入参数i

*@see Hello

*@throws IOException io异常

*/

public static String f2(int i)throws IOException{

System.out.println("f1()!");

return "OK";

}

} /span

注意：

如果源文件中有用到@version,@author标记，则在执行javadoc命令时，要加-version -author

javadoc -version -author -d doc *.java

（其中用-version用于提取源文件中的版本信息 -author用于提取源文件中的作者信息）

java里的注解都有哪些？都有什么用处啊？

注释有 3 中基本类型a. 标记注释 -- 没有变量，只有名称标识。例如 @annotationb. 单一值注释 -- 在标记注释的基础上提供一段数据。如 @annotation(“data”)c. 完整注释 -- 可以包括多个数据成员，每个数据成员由名称和值构成。@annotation(val1="data1",val2="data2")Java 中提供 3 个内置注释类型a. Override ，只能用于方法 ( 不能用于类，包声明或者其他构造 )作用：可以保证编译时候 Override 函数的声明正确性用法： @Overridepublic void fun(){..}b.Deprecated 同样只能作用与方法作用：对不应再使用的方法进行注解用法： @Deprecated public void fun{...} // 它们说这个注释跟函数要同一行c.SupressWarnings 可以注释一段代码作用：关闭特定的警告信息，例如你在使用泛型的时候未指定类型用法： @SupressWarnings(value={"unchecked"}).. 代码Java 中还提供了四种元注释，专门负责注释其他的注释@Target 表示该注释可以用于什么地方。可用的 ElementType 参数包括：CONSTRUCTOR : 构造器的声明FIELD : 域声明 ( 包括 enum 实例 )LOCAL_VARIABLE : 局部变量声明METHOD : 方法声明PACKAGE : 包声明PARAMETER : 参数声明TYPE : 类、接口 ( 包括注解类型 ) 或 enum 声明@Retention 表示需要在什么级别保存该注释信息。可选的 RetentionPoicy 参数包括：SOURCE : 注释将被编译器丢掉CLASS : 注释在 class 文件中可用，但会被 VM 丢弃RUNTIME : VM 将在运行时也保留注释，因此可以通过反射机制读取注释的信息。

java注释参数的介绍就聊到这里吧，感谢你花时间阅读本站内容，更多关于java注释规范、java注释参数的信息别忘了在本站进行查找喔。