注解实例_文档注解

文档注解是一种特殊类型的注解，用于为代码添加文档和说明信息。这些注解通常不会直接影响代码的执行，而是提供给开发者、工具和框架来生成文档、提供提示和辅助信息。

在Java中，有一些常见的文档注解，包括：

@param：用于为方法的参数添加说明文档。在方法的Javadoc注释中，可以使用@param注解来描述每个参数的用途、限制或预期值。

@return：用于为方法的返回值添加说明文档。在方法的Javadoc注释中，可以使用@return注解来描述方法返回值的含义、可能的取值或特殊情况。

@throws：用于为方法抛出的异常添加说明文档。在方法的Javadoc注释中，可以使用@throws注解来列出方法可能抛出的异常以及异常的原因或条件。