【问题标题】:What does @code mean in Google Closure?Google Closure 中的@code 是什么意思?
【发布时间】:2016-10-04 22:52:56
【问题描述】:

这里有一个例子:

* 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 文档,但找不到。谢谢:)

【问题讨论】:

  • 我认为@code是一个Javadoc标签,基本上意味着里面的文本不应该被视为HTML,而是代码块。但在这种情况下,我认为这只是为了让文本在文档期间看起来不同,因为 goog.events.Listenable 在 HTML 中很好。
  • Keith 是正确的,应该写一个答案。这可能是使用这些旧 Javadoc 标记从 Java 转换为 Javascript 的代码。在最近的闭包库代码中,markdown 用于文档,文档是使用Dossier 生成的

标签: javascript google-closure-compiler google-closure-library


【解决方案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 标记。这使您可以使用常规尖括号()代替 doc cmets 中的 HTML 实体(),例如参数类型 ()、不等式 (3

    {@code A<B>C}
    

    在生成的 HTML 页面中显示不变,如:

    A<B>C
    

    值得注意的一点是,它没有被解释为粗体并且是代码字体。 如果您想要没有代码字体的相同功能,请使用 {@literal}。

来源:docs.oracle.com

【讨论】:

  • 作为后续,纯粹是为了文档,对闭包编译器没有特殊意义。
猜你喜欢
  • 1970-01-01
  • 2022-12-14
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 2013-01-02
  • 1970-01-01
相关资源
最近更新 更多