使用jsDoc进行文本/代码高亮显示

Question

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

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

在jsDoc中，无论我使用 `word` 还是 <code>word</code>，效果都只是将斜体样式应用于该单词，无法清晰地显示为保留字。

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

或者，是否有一种方法可以自定义它 - 为标准的MD标签提供自己的CSS？

- vitaly-t

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的框架，使用类似于JSDoc注释来生成文档。 根据其API参考文档，您可以使用<pre class="javascript">以内联方式突出显示JavaScript语法代码，并且看起来非常好：http://manual.qooxdoo.org/3.0/pages/development/api_jsdoc_ref.html#html

- NotGaeL