@use JSDoc

語法

{@tutorial tutorialID} [連結文字]{@tutorial tutorialID}

概述

{@tutorial} 內嵌標籤會建立連結到您指定的教學識別碼。當您使用 {@tutorial} 標籤時，您也可以提供連結文字，使用多種不同的格式之一。如果您沒有提供任何連結文字，JSDoc 會使用教學標題作為連結文字。

如果您需要連結到名稱路徑或 URL，請使用 {@link} 內嵌標籤，而不是 {@tutorial} 標籤。

範例

下列範例顯示提供連結文字給 {@tutorial} 標籤的所有方式

提供連結文字
/**
 * See {@tutorial gettingstarted} and [Configuring the Dashboard]{@tutorial dashboard}.
 * For more information, see {@tutorial create|Creating a Widget} and
 * {@tutorial destroy Destroying a Widget}.
 */
function myFunction() {}

如果所有這些教學都已定義，且 gettingstarted 教學的標題為「入門」，上面的範例會產生類似下列的輸出

針對 {@link} 標籤的輸出
See <a href="tutorial-gettingstarted.html">Getting Started</a> and
<a href="tutorial-dashboard.html">Configuring the Dashboard</a>.
For more information, see <a href="tutorial-create.html">Creating a Widget</a> and
<a href="tutorial-destroy.html">Destroying a Widget</a>.