如何设置JSDoc教程标题？

Question

我正在使用JSDoc教程，如http://usejsdoc.org/about-tutorials.html中所述

我无法让配置选项发挥作用，而且我还没有在网上找到任何关于这个主题的示例或讨论。

在我的简单示例中，我将一个教程参数传递给JSDoc，并为tutorial1.md构建一个教程文件。我想给本教程一个显示名称为“第一教程”。

以下是在线文档中的内容：

每个教程文件可以有额外的..js/..json文件(具有相同的名称，只是不同的扩展名)，该文件将包含额外的教程配置。支持两个字段： 标题用它的值中指定的名称覆盖教程的显示名称(教程的默认标题是它的文件名)。 包含子教程标识符列表的子类。

我尝试了几次尝试添加tutorial1.json或tutorial1.js，但是要么是JSDoc在json文件上吐了出来，要么是我在js文件中抛出的任何东西都看不出来。

有人能为应该工作的教程配置文件提出一个简单的格式吗？

(编辑后包含我尝试过的一个.js文件，该文件没有更改教程显示名称。)

tutorial1.md

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

tutorial1.js

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

Answer 1

它适用于.json扩展，但不适用于.js扩展。如果使用.js扩展名，jsdoc似乎甚至不尝试读取该文件。因此，文档似乎不正确。

使用.json扩展，并使用jsdoc3.2.2，可以实现以下工作：

{
    "title": "Custom Title"
}

您的.json文件需要与您的.md文件位于同一个目录中，并且具有相同的名称(忽略扩展名)。