Java转义字符以及注释_4

Java 转义字符

Java转义符	含义
反斜杠(\)为转义符	转义符只能在字符串（String）或字符（char）中使用。
\t	制表符（Tab）
\n	换行符（Newline）
\r	回车符，定位到行首
\b	退格符
\r\n	Windows 使用 \r\n 作为换行符

Java注释类型	语法
单行注释	//
多行注释	/* ... */
文档注释	/** ... */

文档注释

文档注释用于生成程序的 API 文档，可以用在类、方法、字段上来描述相关功能和用法，注释内容可以包含普通文本和特殊的 Javadoc 标签。

生成文档命令：

javadoc -d 要生成文档的路径 Calculator.java

标签	作用
@author	描述类的作者
@version	描述类的版本
@param	描述方法的参数
@return	描述方法的返回值
@throws	描述方法可能抛出的异常
@see	提供相关的参考链接或类
@since	描述从哪个版本开始引入
@deprecated	标记方法或类已过时，不推荐使用
{@code}	以代码格式显示文本
{@link}	插入指向其他类或方法的链接

• 类注释示例

/*** 这是一个计算器类，提供基本的加减乘除功能。* * @author qqq* @version 1.0* @since 2000-10-01*/
public class Calculator {// 类的内容
}

• 方法注释示例

/*** 计算两个整数的和。* * @param a 第一个整数* @param b 第二个整数* @return 两个整数的和* @throws IllegalArgumentException 如果参数为负数*/
public int add(int a, int b) throws IllegalArgumentException {if (a < 0 || b < 0) {throw new IllegalArgumentException("参数不能为负数");}return a + b;
}

• 字段注释

/*** 存储计算器的名称。*/
private String name;

• 内联标签

/*** 使用 {@code add(int a, int b)} 方法计算两个整数的和。* 更多信息请参考 {@link Calculator} 类。*/
public void exampleMethod() {// 方法内容
}