使用 Markdown 插件

概述

JSDoc包括markdown插件，自动把Markdown-formatted文本转换成HTML。你可以在任何JSDoc模板中使用这个插件。在JSDoc3.2.2及以后版本中，Markdown插件使用了marked Markdown 解析器。

注意：当您启用Markdown插件，一定要在您JSDoc注释的每行前面加上前导星号。如果省略前导星号，JSDoc解析器可能会删除用于markdown格式化的星号。

默认情况下，JSDoc会在以下JSDoc标签中查找markdown格式的文本：

@author
@classdesc
@description (包括在JSDoc注释开始地方的未标记的)
@param
@property
@returns
@see
@throws

启用 Markdown 插件

要启用markdown插件，只要将字符串plugins/markdown添加到JSDoc配置文件的plugins数组中即可。

示例: JSON配置文件中启用 Markdown 插件

{
    "plugins": ["plugins/markdown"]
}

在额外的JSDoc标签中转换Markdown

默认情况下，markdown插件只处理特定JSDoc标签的markdown文本。您可以通过添加一个 markdown.tags属性到你的JSDoc配置文件中，来处理的其他标签中的markdown文本。markdown.tags属性包含一个额外的doclet属性的数组，这个doclet属性可以包含markdown文本。（在大多数情况下，doclet属性的名称相同的标签名。然而，一些标签存储方式不一样;例如，@param 标签存储在的doclet的params属性。如果你不知道如何标签的文本存储在一个doclet中，运行JSDoc使用-X/--explain，打印每个的doclet到控制台）

例如，如果foo和bar标签接受在一个的doclet的foo和bar属性中存储值，你可以通过添加下面的设置到您JSDoc配置文件，来使用markdown处理这些标签。

示例: 转换'foo'和'bar'标签中的Markdown

{
    "plugins": ["plugins/markdown"],
    "markdown": {
        "tags": ["foo", "bar"]
    }
}

剔除markdown默认处理的标签

为了防止Markdown插件处理任何默认JSDoc标签，添加一个markdown.excludeTags属性到您的JSDoc配置文件。该markdown.excludeTags属性包含不应该被markdown文本处理的默认标签数组。

示例: 从markdown处理排除author标签：

{
    "plugins": ["plugins/markdown"],
    "markdown": {
        "excludeTags": ["author"]
    }
}

用换行符换行文本

默认情况下，Markdown插件不处理换行符换行的文本。这是因为，这是正常的JSDoc注释可以多行。如果您更喜欢处理换行符换行的文本，设置JSDoc配置文件中的markdown.hardwrap属性为true。此属性是在JSDoc3.4.0及更高版本中可用。

添加ID属性到标题标签

默认情况下，Markdown插件不会给每个HTML标题标签添加id 属性。想要标题标签文本自动添加ID属性，设置JSDoc配置文件markdown.idInHeadings属性为true。此属性是在JSDoc3.4.0及更高版本中可用。