「java方法注释参数」java注释方式

本篇文章给大家谈谈java方法注释参数，以及java注释方式对应的知识点，希望对各位有所帮助，不要忘了收藏本站喔。

本文目录一览：

• 1、java方法名前注释问题
• 2、java 中的几种注释方式
• 3、Java 中的@param 注解如何使用?
• 4、怎么动态给java注解参数赋值？
• 5、java程序注释
• 6、Java中文档注释各字段的含义是什么？例如author表示作者，para表示参数等

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 中的几种注释方式

三种类型：

1、单选注释：符号是：//

2、块注释： 符号是： /* */ 可以跨多行

3、javadoc注释： 符号是： /** */ 可以跨多行，

生成javadoc时，这样的注释会被生成标准的javaapi注释。

Java 中的@param 注解如何使用?

注解，@param是参数的解释。如：/***@param s 这里表示对s的文字说明，描述*/public void aa(String s){}一般java中@表示注解，解释一个方法，类，属性的作用。

一. 基本概念

Java是一种可以撰写跨平台应用软件的面向对象的程序设计语言。Java 技术具有卓越的通用性、高效性、平台移植性和安全性，广泛应用于PC、数据中心、游戏控制台、科学超级计算机、移动电话和互联网，同时拥有全球最大的开发者专业社群。

二. 研发背景

Java是由Sun Microsystems公司推出的Java面向对象程序设计语言（以下简称Java语言）和Java平台的总称。Java由James Gosling和同事们共同研发，并在1995年正式推出。Java最初被称为Oak，是1991年为消费类电子产品的嵌入式芯片而设计的。1995年更名为Java，并重新设计用于开发Internet应用程序。用Java实现的HotJava浏览器（支持Java applet）显示了Java的魅力：跨平台、动态Web、Internet计算。

怎么动态给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程序注释

也不知道你是想问怎么写文档注释,还只是把代码注释一边!

得了我全帮你给整了吧..就当练习一次了!

/**

P1.编写 Java 程序用于显示人的姓名和年龄。

P2.定义一个人类Person。 该类中应该有两个[私有]属性： 

P3.姓名 （name） 和年龄 （age） 。

P4.定义构造方法用来初始化数据成员。

P5.再定义显示（display()） 方法将姓名和年龄打印出来。

P6.在 main 方法中创建人类的实例然后将信息显示。

@author 作者名字

@version 版本号

*/

package com.baidu.zq01;//包路径!

class Person    //类名!

{

/**

 私有成员属性!

*/

private String name;

private int age;

/**

空构造方法

*/

public Person()

{

}

/**

形参构造方法

@param name 参数name传入值!

@param age 参数age传入值!

*/

public Person(String name, int age)

{

this.name = name;

this.age = age;

}

/**

 对外提供一个获取成员变量name的方法!

@return 返回一个name的值!

*/

public String getName()

{

return name;

}

/**

  对外公开修改成员属性name的值!

@param name 传入一个name值赋给成员变量!

*/

public void setName(String name)

{

this.name = name;

}

/**

  对外提供一个可以获取age值的方法!

@return 返回一个int类型的age

*/

public int getAge()

{

return age;

}

/**

  对外公开修改成员属性age的值!

@param age 传入一个age值赋给成员变量!

*/

public void setAge(int age)

{

this.age = age;

}

/**

  对外提供一个方法获取并打印出成员变量!

*/

public void display() 

{

System.out.println("我的名字是："+name+"，我今年"+age+"岁了");

}

}

//主类

public class TestPerson 

{

public static void main(String[] args)

{

//创建对象,通过形参构造函数,传值初始化来进行创建!

Person p = new Person("张强",6);

//调用对象的display方法!

p.display();

}

}

生成的帮助文档我没办法给你啊,给你截图吧!

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注释方式的介绍到此就结束了，不知道你从中找到你需要的信息了吗 ？如果你还想了解更多这方面的信息，记得收藏关注本站。