购物车
登陆 / 注册
微信扫码登陆

推荐手册

使用Markdown插件

使用Markdown插件
SDoc包括markdown插件,自动把Markdown-formatted文本转换成HTML。你可以在任何JSDoc模板中使用这个插件。在JSDoc3.2.2及以后版本中,Markdown插件使用了marked Markdown 解析器。
编辑:青灯夜游 青灯夜游 更新时间:2019-01-07 15:48:04

使用Markdown插件

Overview(概述)

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

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

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

Enabling the Markdown plugin(启用markdown插件)

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

示例,配置文件启用markdown插件:

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

Converting Markdown in additional JSDoc tags(在额外的JSDoc标签中转换Markdown)

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

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

例如,转换’foo’和’bar’标签中的Markdown

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

Excluding the default tags from Markdown processing(剔除markdown默认处理的标签)

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

例如,从markdown处理排除author标签:

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

Hard-wrapping text at line breaks (用换行符换行文本)

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

Adding ID attributes to headings(添加ID属性到标题标签)

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

网站导航
网站首页
学习路径
视频教程
开发软件
旗下子站
php中文网
phpstudy
技术文章
文档工具
关于我们
企业合作
人才招聘
联系我们
讲师招募
QQ交流群
QQ交流群
微信公众号
微信公众号