首页 > 解决方案 > 何时使用 @NotNull 和 @Nullable IntelliJ 注释?

问题描述

我刚开始使用那些 IntelliJ IDEA Java 注释,但我不明白什么时候应该使用它们,特别是因为 IDEA 大部分时间都能够推断它们。

你们遵守某种规则吗?我不希望看到用它们注释的每个参数或字段,代码可能会变得一团糟。

我知道这可以被认为是基于意见的,但我仍然想阅读答案。

标签: javaintellij-ideaannotations

解决方案


@Nullable@NotNull注释用于指示某些东西(参数、属性等)可以(或不能)是的IDE null。通过这种方式,它可以帮助您检测可能不正确的代码。

这不是“必须遵循”的规则,而是另一个帮助开发人员在使用 IDE 时编写更健壮且不易出错的代码的工具。

如果你一个人编码,团队很小,你在一个小项目或任何类似的情况下工作......并且你觉得没有它很舒服,那么不要使用它,因为确实代码变得有点冗长。这并不意味着这对以前的任何情况都没有用(它实际上也很有帮助)。

另一方面,如果您认为您需要一个额外的工具来帮助您针对不可为“空”的值检测可能失败的代码,或者,例如,您正在编写一个供第三方使用的 API 并希望使用它注释而不是代码块内的几个asserts ......然后去吧。

这一切都是关于评估项目中的利弊您可以在其中应用这些注释并决定这是否会给您带来比它可能导致的“问题”更多的好处。


推荐阅读