文本/代码突出显示jsDoc

Question

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

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

在jsDoc，我是否使用`word`或<码字> < /代码>，其效果也只是设置斜体样式到字，不能清楚地看到作为一个保留字。

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

另外，有没有一种方法来定制它 - 提供我自己的CSS标准的MD标签？

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