我正在使用 JSDoc 教程,如中所述http://usejsdoc.org/about-tutorials.html http://usejsdoc.org/about-tutorials.html
我无法获取配置工作选项,我还没有在网上找到该主题的任何示例或讨论。
在我的小例子中,我传递了一个教程参数传递给 JSDoc,它会为tutorial1.md 构建一个教程文件。我想为本教程指定一个显示名称“First Tutorial”。
从在线文档中可以看出:
每个教程文件可以有额外的 .js/.json 文件(具有相同的名称,只是扩展名不同),它将保存额外的教程配置。支持两个字段:
title 使用其值中指定的名称覆盖教程的显示名称(教程的默认标题是其文件名)。
包含子教程标识符列表的孩子。
我尝试了几次添加tutorial1.json或tutorial1.js,但JSDoc要么在json文件上呕吐,要么似乎无法识别我在js文件中扔给它的任何内容。
任何人都可以建议一个应该有效的教程配置文件的简单格式吗?
(经过编辑以包含我尝试过的一个 .js 文件,该文件没有更改教程显示名称。)
教程1.md
First Tutorial
================
教程1.js
/**
@title First Tutorial
*/
@title = "First Tutorial";
title = "First Tutorial";
它适用于.json
扩展名但不带有.js
扩大。 jsdoc 似乎没有尝试甚至read该文件如果.js
使用扩展名。所以doc http://usejsdoc.org/about-tutorials.html似乎不正确。
With a .json
扩展,并使用 jsdoc 3.2.2,可以执行以下操作:
{
"title": "Custom Title"
}
Your .json
文件需要与您的文件位于同一目录中.md
文件并具有相同的名称(忽略扩展名)。
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)