如何设置JSDoc教程标题？

Question

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

中所述

我无法使用配置选项，我还没有在线找到任何关于该主题的示例或讨论。

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

在线文档之后：

  

每个教程文件都可以有其他.js / .json文件（具有相同的名称，只是不同的扩展名），这将包含其他教程配置。支持两个字段：

     

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

     

包含子教程标识符列表的子项。

我尝试了多次尝试添加tutorial1.json或tutorial1.js，但是在json文件中使用了JSDoc pukes，或者似乎没有识别我在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文件位于同一目录中，且名称相同（忽略扩展名）。