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

Question

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

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

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

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