javascript - Google Closure 中的 @code 是什么意思？

Question

这里是一个例子:

* An implementation of {@code goog.events.Listenable} with full W3C
* EventTarget-like support (capture/bubble mechanism,

https://developer.pubref.org/static/apidoc/global/closure/goog/events/EventTarget.html

我能猜到它的意思，但我在哪里可以找到它的确切定义？我检查了所有 Google Closure Annotation 文档，但找不到。谢谢:)

Answer 1

已更新

根据我的新理解；由于 JSDocs 支持 Markdown 。 {@code FooBar} 因此被弃用，取而代之的是反引号 `FooBar` .

旧

您可以在 Closure API's documentation page for goog.events.EventTarget 上看到您所询问的文档的输出。 .

当呈现 JSDocs 时，@code 标记将导致括号中的代码呈现为 <code></code>。元素。

来源:js-dossier

还有来自 JavaDocs 的更好的文档...文档:

{@code text}

• 相当于{@literal} .

• 以代码字体显示文本，而不将文本解释为 HTML 标记或嵌套的 javadoc 标记。这使您能够在文档注释中使用常规尖括号(< 和 >)而不是 HTML 实体(< 和 >)，例如在参数类型 ()、不等式 (3 < 4) 或箭头 (<-) 中。例如文档注释文本:

  {@code A<B>C}
  

  在生成的 HTML 页面中显示为:

  A<B>C
  

  值得注意的一点是，不会被解释为粗体，而是代码字体。如果您想在没有代码字体的情况下获得相同的功能，请使用 {@literal}。

来源:docs.oracle.com