使用jsDoc突出显示文本/代码

Question

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

在MD语法中，我可以使用`word`，它会设置灰色背景和不同的字体，因此您可以清楚地看到它，与StackOverflow上的相同 - word。

在jsDoc中，无论我使用`word`还是＆lt; code＆gt; word＆lt; / code＆gt;，效果只是为单词设置斜体样式，不能将其视为保留字。

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

或者，有没有办法自定义它 - 为标准的MD标签提供我自己的CSS？

Answer 1

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

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

有关于如何编辑或创建自己的JSDoc模板的指南，以及有关如何覆盖默认模板布局文件的部分：

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

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

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