@code在Google Closure中意味着什么?

时间:2016-10-04 22:52:56

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

这里有一个例子:

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

1 个答案:

答案 0 :(得分:4)

更新

根据我的新理解;由于JSDocs支持markdown。因此,不推荐使用{@code FooBar},以支持反向标记`FooBar`

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

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

来源:js-dossier

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

{@ code text}

  • 相当于{@literal}

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

    {@code A<B>C}
    

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

    A<B>C
    

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

来源:docs.oracle.com