java--注释

最新推荐文章于 2024-01-02 21:45:51 发布

原创最新推荐文章于 2024-01-02 21:45:51 发布 · 364 阅读

0 ·

CC 4.0 BY-SA版权

java基础专栏收录该内容

64 篇文章

订阅专栏

本文深入解析了Java注释的三种类型及其使用场景，特别着重介绍了文档注释的功能和编写方法，通过具体例子展示了如何为类、方法和属性添加有意义的文档注释，以提高代码的可读性和维护性。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

Java注释我们主要有三种：

1,　// ：注释一行
2,　/* ...... */：注释若干行

3,　/**……*/：文档注释

一个文档注释的例子

/**
这是一个定义人的信息的类，该类中提供了人的信息获取，输出打印等功能。
@author Navan
@version 0.0.0.1
*/

public class Person
{
	/**
	空参数构造函数
	*/
	public Person()
	{}
	/**
	有参数构造函数，获取对象的名字。
	@param name 接受一个String类型的字符串。
	*/
	public Person(String name)
	{
		this.name=name;	
	}
	/**
	有参数构造函数，获取对象的名字和年龄。
	@param name 接受一个String类型的字符串。
	@param age 接受一个int类型的数字。
	*/
	public Person(String name,int age)
	{
		this.name=name;
		this.age=age;
	}
	/**
	有参数构造函数，获取对象的名字，年龄，性别。
	@param name 接受一个String类型的字符串。
	@param age 接受一个int类型的数字。
	@param gender 接受一个String类型的字符串。
	*/
	public Person(String name,int age,String gender)
	{
		this.name=name;
		this.age=age;
		this.gender=gender;
	}

	private String name;
	int age;
	private String gender;
	static String nation="中国";

	/**
	获取一个人的名字。
	@param name 接受一个String类型的字符串。
	*/
	public void setName(String name)
	{
		this.name=name;
	}
	/**
	返回一个人的名字
	@return name 返回一个String类型的字符串。
	*/
	public String getName()
	{
		return name;
	}
	/**
	获取一个人的年龄。
	@param age 接受一个int类型的数字。
	*/
	public void setAge(int age)
	{
		this.age=age;
	}
	/**
	返回一个人的年龄。。
	@return age 返回一个int类型的数字。
	*/
	public int getAge()
	{
		return age;
	}
	/**
	获取一个人的性别。
	@param gender 接受一个String类型的字符串。
	*/
	public void setGender(String gender)
	{
		this.gender=gender;
	}
	/**
	返回一个人的年龄。
	@return gender 返回一个String类型的字符串。
	*/
	public String getGender()
	{
		return gender;
	}

	/**
	用于打印对象的信息，打印成：
-----------
名字:周六
年龄:35
性别:女
国家:中国
	*/
	public void print()
	{
		System.out.println("-----------");
		System.out.println("名字:"+name);
		System.out.println("年龄:"+age);
		System.out.println("性别:"+gender);
		System.out.println("国家:"+nation);

	}
}

使用javadoc 命令，制作成说明文档