如何设置JSDoc教程标题？

Question

我使用JSDoc教程，如http://usejsdoc.org/about-tutorials.html

描述我无法得到配置选项来工作，我还没有找到话题的任何实例或讨论网上。

在我的小例子中，我将一个教程参数传递给JSDoc，并为tutorial1.md构建了一个教程文件。我想给这个教程显示“First Tutorial”的名字。

在此之后，从在线文档：

每个教程文件可以有额外的.js /上传.json文件（名称相同，只是不同的扩展名）将举行额外的教程配置。支持两个字段：

标题覆盖教程的显示名称，并在其中指定值（教程的默认标题是文件名）。

保存子教程标识符列表的子代。

我试过几次试图在增加tutorial1.json，或tutorial1.js但无论是JSDoc pukes的JSON文件，或者似乎不承认任何我在js文件扔掉它。

任何人都可以建议一个简单的格式为应该工作的教程配置文件？

（编辑，包括一个.js文件我想，这并没有改变教程显示名称。）

tutorial1.md

First Tutorial 
================ 

tutorial1.js

/** 
@title First Tutorial 
*/ 
@title = "First Tutorial"; 
title = "First Tutorial"; 

Answer 1

它与.json分机一起使用，但不能与.js分机一起使用。如果使用.js扩展名，jsdoc似乎甚至不会尝试使用读取文件。所以doc似乎不正确。

随着.json扩展，并采用jsdoc 3.2.2，以下工作：

{ 
    "title": "Custom Title" 
} 

你.json文件需要在相同的目录中.md文件，并具有相同的名称（忽略扩展） 。