首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

如何编写带有参数@link的javadoc @deprecated方法

带有参数@link的javadoc @deprecated方法是一种在Java代码中使用javadoc注释来标记已过时方法的方式。@deprecated注释用于指示该方法已被废弃,不再推荐使用,通常是因为存在更好的替代方法或者该方法存在安全漏洞或错误。

编写带有参数@link的javadoc @deprecated方法的步骤如下:

  1. 在方法的注释块前添加@deprecated注释,用于标记该方法已过时。
  2. 在@deprecated注释后面的文本中,提供一些说明,解释为什么该方法被废弃以及推荐使用哪个替代方法。
  3. 在方法的注释块中,使用{@link}标签来引用推荐的替代方法。

以下是一个示例:

代码语言:txt
复制
/**
 * 这是一个已过时的方法,不推荐使用。
 * 原因:该方法存在安全漏洞。
 * 推荐使用{@link #newMethod()}方法来替代。
 * 
 * @deprecated
 */
@Deprecated
public void oldMethod() {
    // 方法实现
}

/**
 * 这是推荐使用的新方法。
 * 
 * @see #oldMethod()
 */
public void newMethod() {
    // 方法实现
}

在上述示例中,oldMethod()方法被标记为已过时,并在注释中说明了废弃原因和推荐的替代方法newMethod()。在newMethod()的注释中,使用{@link}标签引用了oldMethod()方法,以便开发人员可以方便地查看替代方法的具体实现。

腾讯云相关产品和产品介绍链接地址:

  • 腾讯云官网:https://cloud.tencent.com/
  • 云服务器(CVM):https://cloud.tencent.com/product/cvm
  • 云数据库 MySQL 版:https://cloud.tencent.com/product/cdb_mysql
  • 云原生应用引擎(TKE):https://cloud.tencent.com/product/tke
  • 人工智能平台(AI Lab):https://cloud.tencent.com/product/ai
  • 物联网套件(IoT Suite):https://cloud.tencent.com/product/iotexplorer
  • 移动推送服务(TPNS):https://cloud.tencent.com/product/tpns
  • 云存储(COS):https://cloud.tencent.com/product/cos
  • 腾讯区块链服务(TBCS):https://cloud.tencent.com/product/tbcs
  • 腾讯元宇宙(Tencent Metaverse):https://cloud.tencent.com/solution/metaverse
页面内容是否对你有帮助?
有帮助
没帮助

相关·内容

Redis–SpringCache(二)带有参数方法缓存

一.带有参数方法缓存 在@Cacheablekey属性中通过#参数名可以获取到方法参数。key中内容Spring EL,既然是表达式字符串要用单引号,没有被单引号包含内容都表示变量。...注意:基本上当方法参数时,设置key时候需要添加上参数条件。因为参数不一样,方法返回值也可以不一样了。...@Override // Spring EL // 字符串使用单引号 // #+方法参数名称:可以调用方法参数 @Cacheable(key = "'selectById...System.out.println("执行了selectById:"+id); return "selectById"+id; } 二.返回值为对象或集合 1.会出现问题...这是因为默认对Redisvalue序列化器使用JdkSerializationRedisSerializer序列化器。

1.3K20
  • Java 注释

    (一)注释重要性 编写程序时候,总需要为程序添加一些注释,用以说明某段代码作用,或者说明某个类用途,某个方法工能,以及该方法参数和返回值数据类型以及意义等 程序注释作用非常大...javadoc 工具软件识别以下标签: 标签 描述 示例 @author 标识一个类作者 @author description @deprecated 指名一个过期类或成员 @deprecated...{@link} 插入一个到另一个主题链接 {@link name text} {@linkplain} 插入一个到另一个主题链接,但是该链接显示纯文本字体 Inserts an in-line link...@param 说明一个方法参数 @param parameter-name explanation @return 说明返回值类型 @return explanation @see 指定一个到另一个主题链接...由于 javadoc 实现不同,工作也可能不同,你需要检查你 Java 开发系统版本等细节,选择合适 Javadoc 版本。

    1.2K10

    改善Java文档理由、建议和技巧

    使用@link和@linkplain来指向某些代码 在我Javadoc中,如果有依赖关系或者对文档有用,我会提及其它类和方法。为了使方法和类浏览更简便,你可以使用@link。...它是这样工作: {@link BurgersManager} 指向一个类 {@link BurgersManager burgers manager} 指向带有标签类 {@link #eat(Burger..., boolean)} 指向此类中某个方法 {@link #eat(Burger, boolean) eat} 指向此类中带有标签某个方法 {@link BurgersManagers#eat(Burger..., boolean)} 指向其他类中某个方法 {@link BurgersManagers#eat(Burger, boolean) burgers manager eat} 指向其他带有标签某个方法...用@param说明参数含义 有什么比看到方法使用一个像 i 这样意义不明参数而不加任何文档更加沮丧呢?有时候你可以通过方法名字来猜到这个参数目的,可是有时候就不行。

    45310

    改善Java文档理由、建议和技巧

    使用@link和@linkplain来指向某些代码 在我Javadoc中,如果有依赖关系或者对文档有用,我会提及其它类和方法。为了使方法和类浏览更简便,你可以使用@link。...它是这样工作: {@link BurgersManager} 指向一个类 {@link BurgersManager burgers manager} 指向带有标签类 {@link #eat(Burger..., boolean)} 指向此类中某个方法 {@link #eat(Burger, boolean) eat} 指向此类中带有标签某个方法 {@link BurgersManagers#eat(Burger..., boolean)} 指向其他类中某个方法 {@link BurgersManagers#eat(Burger, boolean) burgers manager eat} 指向其他带有标签某个方法...用@param说明参数含义 有什么比看到方法使用一个像 i 这样意义不明参数而不加任何文档更加沮丧呢?有时候你可以通过方法名字来猜到这个参数目的,可是有时候就不行。

    30410

    javadoc

    javadoc是Sun公司提供一个技术,它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套API帮助文档。...也就是说,只要在编写程序时以一套特定标签作注释,在程序编写完成后,通过Javadoc就可以同时形成程序开发文档了。...作者 作者标识 √ √ 包、 类、接口 @version 版本号 版本号 √ √ 包、 类、接口 @param 参数名 描述 方法入参名及描述信息,如入参有特别要求,可在此注释。...√ √ 构造函数、 方法 @return 描述 对函数返回值注释 √ √ 方法 @deprecated 过期文本 标识随着程序版本提升,当前API已经过期,仅为了保证兼容性依然存在,以此告之开发者不应再用这个...√ √ 包、类、接口、值域、构造函数、 方法 {@link包.类#成员 标签} 链接到某个特定成员对应文档中。

    40430

    Java三种注释

    也就是说,只要在编写程序时以一套特定标签注释,在程序编写完成后,通过 Javadoc 就形成了程序 API 帮助文档。...Javadoc 可以识别的标签如下表所示: 标签 描述 示例 @author 标识一个类作者,一般用于类注释 @author description @deprecated 指名一个过期类或成员,表明该类或方法不建议使用...@deprecated description {@docRoot} 指明当前文档根目录路径 Directory Path @exception 可能抛出异常说明,一般用于方法注释 @exception...{@link} 插入一个到另一个主题链接 {@link name text} {@linkplain} 插入一个到另一个主题链接,但是该链接显示纯文本字体 Inserts an in-line link...@param 说明一个方法参数,一般用于方法注释 @param parameter-name explanation @return 说明返回值类型,一般用于方法注释,不能出现再构造方法中 @return

    82410

    Java 文档注解最全详解,建议收藏!

    二、文档注释格式总结 Java 文档注释是专门为了用 javadoc 工具自动生成文档而编写一套注释标准,通过 javadoc 命令可以把文档注释中内容生成文档,并输出到 HTML 文件中,与一般注释有所不同...适用范围:包、类、接口、方法、成员属性、构造器 注意事项:1、@link 和 @linkplain区别在于:@link直接将将超链接中地址当作显示文本,其格式为 {@link 地址};而 @linkplain...2、@link 和 @see区别在于:@link可以放在某一行中任意位置;而 @see必须放在某一行中最开始。...适用范围:包、类、接口、方法、成员属性、构造器 案例如下: /** * @deprecated As of JDK 1.1, replaced by * {@link #setBounds(int,...javadoc SquareNum.java 四、小结 Javadoc 是一款为程序生成 API 文档工具,只需按照规定格式编写代码文档注释,即可生成 API 帮助文档。

    1.3K10

    如何生成一套标准 Java API 文档?

    二、文档注释格式总结 Java 文档注释是专门为了用 javadoc 工具自动生成文档而编写一套注释标准,通过 javadoc 命令可以把文档注释中内容生成文档,并输出到 HTML 文件中,与一般注释有所不同...适用范围:包、类、接口、方法、成员属性、构造器 注意事项:1、@link 和 @linkplain区别在于:@link直接将将超链接中地址当作显示文本,其格式为 {@link 地址};而 @linkplain...2、@link 和 @see区别在于:@link可以放在某一行中任意位置;而 @see必须放在某一行中最开始。...适用范围:包、类、接口、方法、成员属性、构造器 案例如下: /** * @deprecated As of JDK 1.1, replaced by * {@link #setBounds(int,...javadoc SquareNum.java 四、小结 Javadoc 是一款为程序生成 API 文档工具,只需按照规定格式编写代码文档注释,即可生成 API 帮助文档。

    8810

    Java注释:您想知道一切

    注释可能适用于包,类型(类,接口,枚举和注释类型),变量(类,实例和局部变量-包括在for或while循环中定义变量),构造函数,方法参数。...@已弃用 @Deprecated注释指示已标记元素已弃用,不应再使用。每当程序使用带有@Deprecated批注方法,类或字段时,编译器都会生成警告。...与泛型出现之前编写旧代码进行交互时,可能会发生未经检查警告。...@SafeVarargs @SafeVarargs批注应用于方法或构造函数时,声明该代码不会对其varargs参数执行潜在不安全操作。...ElementType.METHOD可以应用于方法级注释。 ElementType.PACKAGE可以应用于包声明。 ElementType.PARAMETER可以应用于方法参数

    1.5K10

    房上猫:JavaDoc注释

    */ JavaDoc注释    背景:       javadoc是Sun公司提供一个技术,它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套API帮助文档。...也就是说,只要在编写程序时以一套特定标签作注释,在程序编写完成后,通过Javadoc就可以同时形成程序开发文档了。   ...包、 类、接口 @param 参数名 描述 方法入参名及描述信息,如入参有特别要求,可在此注释。...√ √ 构造函数、 方法 @return 描述 对函数返回值注释 √ √ 方法 @deprecated 过期文本 标识随着程序版本提升,当前API已经过期,仅为了保证兼容性依然存在,以此告之开发者不应再用这个...√ √ 包、类、接口、值域、构造函数、 方法 {@link包.类#成员 标签} 链接到某个特定成员对应文档中。

    1.1K100

    Java @Deprecated Annotation(注解)

    在本部分快速指南中,我们将会查看 Java deprecated API 和如何在程序中使用 @Deprecated 注解。...@Deprecated Annotation(注解) 作为程序进化和迭代,随着时间推移,在项目中总会有些类,构造方法,字段,类型或者方法不建议人们继续继续使用。...同时我们还建议在 @Deprecated 注解后面添加一些说明文本来解释如果希望程序或者 API 具有相同功能应该使用何种其他方法。...since – 接受字符串输入参数,用于定义我们丢弃内容从哪个版本开始。默认为空字符串。...结论 在这个快速文章中,我们看到了如何使用 @Deprecated 声明来标记不再使用元素,以及针对 Java 9 我们可以为其设置一些其他属性以及这些属性默认值。

    3.2K20

    idea下使用JavaDoc生产帮助文档

    你自己编写注释转换内容还是根据你注释内容来。 还有一个“Other command line arguments:”可选填项,非常重要,是填写直接向 javadoc.exe 传递参数内容。...这里必须要填写如下参数: -encoding UTF-8 -charset UTF-8 -windowtitle "你文档在浏览器窗口标题栏显示内容" -link http://docs.oracle.com...-windowtitle 表示生成 JavaDoc 超文本在浏览器中打开时,浏览器窗口标题栏显示文字内容;第四个参数 -link 很重要,它表示你生成 JavaDoc 中涉及到很多对其他外部 Java...类引用,是使用全限定名称还是带有超链接短名称,举个例子,我创建了一个方法 public void func(String arg),这个方法在生成 JavaDoc 时如果不指定 -link 参数,...如果指定了 -link http://docs.oracle.com/javase/7/docs/api 参数,则 javadoc.exe 在生成 JavaDoc 时,会使用 String 这样短名称而非全限定名称

    98930

    Java @Deprecated Annotation(注解)

    在本部分快速指南中,我们将会查看 Java deprecated API 和如何在程序中使用 @Deprecated 注解。...@Deprecated Annotation(注解) 作为程序进化和迭代,随着时间推移,在项目中总会有些类,构造方法,字段,类型或者方法不建议人们继续继续使用。...同时我们还建议在 @Deprecated 注解后面添加一些说明文本来解释如果希望程序或者 API 具有相同功能应该使用何种其他方法。...since – 接受字符串输入参数,用于定义我们丢弃内容从哪个版本开始。默认为空字符串。...结论 在这个快速文章中,我们看到了如何使用 @Deprecated 声明来标记不再使用元素,以及针对 Java 9 我们可以为其设置一些其他属性以及这些属性默认值。

    69930

    如何使用高大上方法参数

    Jasper Snoek 就在一次报告中(http://t.cn/RpXNsCs)讲述如何用调参数方法(贝叶斯优化)炒鸡蛋。他只花了大概 30 个鸡蛋就得到了一个很好菜谱。...层与层之间应该如何连接? 应该使用什么样 Activation? 应该使用什么样优化算法? 优化算法初始步长是多少? 初始步长在训练过程中应该如何下降? 应该使用什么样初始化?...那么,既然之前提到贝叶斯算法可以用来炒鸡蛋,为什么现在大家仍然使用博士生人肉搜索这种原始方法做调参数问题呢? 答案是来自高维度诅咒。...解决方法很简单,我们只考虑所谓低度数傅里叶基(Low degree Fourier Basis),即那些最多只包含d个参数相乘基函数。...基于这些特征,我们知道一部分相关参数,以及它们应该如何赋值才能够得到这些特征线性叠加最小值。于是,我们就可以固定这些参数。 这些参数固定之后,其实个数往往不多,一般也就 5、6 个。

    4.3K90

    android-代码样式规范

    Javadoc注释中,描述类或接口作用。 你写每个类和公共方法必须包含一个Javadoc注释,至少有一个句子描述类或方法作用。这句话应以第三人称描述性动词开始。...如何javadoc编写注释 [http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html] 5.写短方法...如果使用@Deprecated注释,则还必须具有@deprecated Javadoc标记,并且应该命名替代实现。此外,请记住,一个@Deprecated方法 仍然应该工作。...如果您看到旧代码带有@deprecated Javadoc标记,请添加@Deprecated注释。 @Override:当方法从超类覆盖声明或实现时,必须使用@Override注释。...例如,如果使用@inheritdocs Javadoc标记,并从类(而不是接口)派生,则还必须注释该方法@覆盖父类方法

    55130
    领券