gpt4 book ai didi

具有@Deprecated 等语义的代码样式的 Java 注释

转载 作者:行者123 更新时间:2023-11-29 05:56:33 27 4
gpt4 key购买 nike

是否有人在项目中有某种“代码风格”注释,例如:@OverEngineered 表示过于复杂的代码或@Duplicated...等。

理想情况下,我会为此创建 @Deprecated 的子类(@OverEngineered 扩展 @Deprecated)以使 IDE 突出显示它,但是 java annotations are not inherited .

所以我想知道是否有一些解决方法可以让 IDE 突出显示已弃用的此类代码样式自定义注释?或者这是错误的方法或错误的任务?

最佳答案

您可以编写一系列这些注释,然后将它们与 @Deprecated 一起使用。后者为您提供警告,前者向人类读者提供详细信息。你可以写一个 Checkstyle规则要求每个弃用的事物都有一个解释性注释,和/或每个解释都伴随着弃用。

不过,我不会写几个注释,而是写一个,它将解释性标签作为参数。我称之为 @BecauseItIs。所以:

@Deprecated @BecauseItIs("overengineered")
public void calculateSumOfTwoIntegersUsingSurfaceIntegrals(int a, int b) {

关于具有@Deprecated 等语义的代码样式的 Java 注释,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/11888654/

27 4 0
Copyright 2021 - 2024 cfsdn All Rights Reserved 蜀ICP备2022000587号
广告合作:1813099741@qq.com 6ren.com