【问题标题】:What are tags like @param and @return in IntelliJ IDEA?IntelliJ IDEA 中的 @param 和 @return 等标签是什么?
【发布时间】:2011-10-09 13:41:09
【问题描述】:

我刚刚开始使用 IntelliJ IDEA 进行 Java 编程,我看到了像 @param 和 @return 这样的标签(它们被称为标签吗?)。 这些标签有什么意义?如果我的代码中没有这些标签,IntelliJ 实际上会抱怨!

哪些是最重要的知识以及它们的用途?

我在 IntelliJ 文档中找不到与这些标签相关的任何内容。

【问题讨论】:

  • 在代码中的cmets中,呵呵。
  • 所需的标签和警告级别是可配置的检查——只需在设置中搜索“javadoc”即可。
  • @Terribad @ 字符被 javadoc(“在 cmets”中)和 java(“在代码中”--annotations)使用。如果它抱怨它们在两个地方都丢失了,那么很可能是大错特错。
  • @DaveNewton:我明白了,我不知道它还有 Javadoc 以外的用途。我不熟悉它在代码中的使用方式(在 cmets 之外)。

标签: java ide intellij-idea


【解决方案1】:

是的,它们被称为标签。如果您在 cmets 中看到这些标签,它们将记录您的方法的参数和返回值。

它们可以被自动处理以生成 JavaDoc 文档。生成的文档将类似于Java API Documentation。见how to write doc comments for the JavaDoc tool

【讨论】:

  • 谢谢。通过应用monkey-see monkey-do,我收集到标签的一般格式是@tag variable_name_if_any description.
  • 不是制表符,只是空格。此外,为了明确起见,这些标签并不特定于 IntelliJ。
  • 这些标签在 IDE 之外创建的代码中是否无用?也就是用文本编辑器创建并在命令行编译的代码?
  • @Terribad 标签被 javadoc(链接到)用来创建 API 文档。
猜你喜欢
  • 1970-01-01
  • 2014-06-16
  • 2021-11-24
  • 2010-09-27
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 2014-01-27
  • 2020-08-16
相关资源
最近更新 更多