Javadoc标签

最新推荐文章于 2024-11-01 17:11:16 发布

死磕java的啦啦啦

最新推荐文章于 2024-11-01 17:11:16 发布

阅读量828

点赞数 1

文章标签： java

本文链接：https://blog.youkuaiyun.com/weixin_49302930/article/details/132301397

版权

Javadoc标签是用于在文档注释中提供额外信息的特殊标记。这些标签以@符号开头，用于描述类、方法、字段等的特性和用法。下面是一些常用的Javadoc标签：

@param：用于描述方法的参数，说明参数的含义和用法。

/**
 * 这是一个示例方法，用于生成Javadoc文档。
 * @param name 姓名
 * @return 欢迎消息
 */
public String sayHello(String name) {
    // ...
}

@return：用于描述方法的返回值，说明返回值的含义和用法。

/**
 * 这是一个示例方法，用于生成Javadoc文档。
 * @param name 姓名
 * @return 欢迎消息
 */
public String sayHello(String name) {
    // ...
}

@throws：用于描述方法可能抛出的异常，说明异常的类型和原因。

/**
 * 这是一个示例方法，用于生成Javadoc文档。
 * @param name 姓名
 * @return 欢迎消息
 * @throws IllegalArgumentException 如果姓名为空
 */
public String sayHello(String name) throws IllegalArgumentException {
    // ...
}

@see：用于提供与当前文档相关的其他类、方法或字段的链接。

/**
 * 这是一个示例方法，用于生成Javadoc文档。
 * @param name 姓名
 * @return 欢迎消息
 * @see AnotherClass#anotherMethod
 */
public String sayHello(String name) {
    // ...
}

@since：用于指定方法、类或字段的引入版本。

/**
 * 这是一个示例方法，用于生成Javadoc文档。
 * @param name 姓名
 * @return 欢迎消息
 * @since 1.0
 */
public String sayHello(String name) {
    // ...
}

@deprecated：用于标记已过时的方法、类或字段，建议使用其他替代方式。

/**
 * 这是一个示例方法，用于生成Javadoc文档。
 * @param name 姓名
 * @return 欢迎消息
 * @deprecated 该方法已过时，请使用新的方法替代
 */
public String sayHello(String name) {
    // ...
}

以上是一些常用的Javadoc标签，可以根据需要在文档注释中使用这些标签来提供更详细的信息和指导。另外，Javadoc还支持其他标签和自定义标签，可以根据具体需求进行使用。