如何設置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文件，並具有相同的名稱（忽略擴展） 。