Text/Code 使用 jsDoc 突出显示

Question

jsDoc 似乎支持大部分 MD 语法，但是当涉及到突出显示单个保留字或文本时，我找不到可用的标签。

在 MD 语法中，我可以使用 `word`，它会设置灰色背景和不同的字体，因此您可以清楚地看到它，就像在 Whosebug 上一样 - word.

在jsDoc中，无论我使用`word`还是word，效果都只是给word设置了斜体样式，看不出是保留字。

jsDoc 中是否有任何语法可以清楚地突出显示单词或文本字符串，例如 MD 中的 `some text`，看起来像 some text？

或者，是否可以自定义它 - 为标准 MD 标签提供我自己的 CSS？

Answer 1

JSDoc 文档似乎使用了 <code> 标签，它通过在 usejavadoc.css 上定义的 code 标签属性上设置它来使用灰色背景突出显示文本。文件：

来自http://usejsdoc.org/tags-name.html：

有关于如何编辑或创建您自己的 JSDoc 模板的指南，其中有一节关于如何覆盖默认模板布局文件：

http://usejsdoc.org/about-configuring-default-template.html#overriding-the-default-template-s-layout-file

但对于像这样简单的事情，您甚至不必走那么远。只需在生成之前或之后编辑 css 片段，然后为 code 标签设置您想要的 background-color。您可以在生成之前通过编辑此行并设置您想要的背景颜色来完成：

https://github.com/jsdoc3/jsdoc/blob/5a58bdf5a551844f12b46be6436aefd3c41e0393/templates/default/static/styles/jsdoc-default.css#L257

或者，如果这不起作用，则通过添加

覆盖 属性

code {
  background-color: #DEDEDE !important;
}

到文件。

作为替代方案，您可以使用 qooxdoo to generate your documentation using JSDoc-like comments. According to their API reference you may use <pre class="javascript"> for inline javascript syntax code highlighting, and it looks pretty nice: http://manual.qooxdoo.org/3.0/pages/development/api_jsdoc_ref.html#html

这样的框架