同義詞

• linkcode
• linkplain

語法

{@link namepathOrURL} [連結文字]{@link namepathOrURL}

概觀

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

如果您需要連結到教學課程，請使用 {@tutorial} 內嵌標籤，而不是 {@link} 標籤。

連結格式

預設情況下，{@link} 會產生標準 HTML anchor 標籤。不過，您可能偏好以等寬字型呈現某些連結，或指定個別連結的格式。您可以使用 {@link} 標籤的下列同義詞來控制連結的格式

• {@linkcode}：強制連結文字使用等寬字型。
• {@linkplain}：強制連結文字顯示為一般文字，不使用等寬字型。

您也可以在 JSDoc 的設定檔中設定下列選項之一；請參閱 設定 JSDoc 以取得更多詳細資料

• templates.cleverLinks：設定為 true 時，連結到 URL 會使用一般文字，而連結到程式碼會使用等寬字型。
• templates.monospaceLinks：設定為 true 時，所有連結都會使用等寬字型，但使用 {@linkplain} 標籤建立的連結除外。

注意：雖然預設 JSDoc 範本會正確呈現所有這些標籤，但其他範本可能無法辨識 {@linkcode} 和 {@linkplain} 標籤。此外，其他範本可能會忽略連結呈現的設定選項。

範例

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

/**
 * See {@link MyClass} and [MyClass's foo property]{@link MyClass#foo}.
 * Also, check out {@link http://www.google.com|Google} and
 * {@link https://github.com GitHub}.
 */
function myFunction() {}

預設情況下，上述範例會產生類似下列的輸出

See <a href="MyClass.html">MyClass</a> and <a href="MyClass.html#foo">MyClass's foo
property</a>. Also, check out <a href="http://www.google.com">Google</a> and
<a href="https://github.com">GitHub</a>.

如果設定屬性 templates.cleverLinks 為 true，上述範例會產生下列輸出

See <a href="MyClass.html"><code>MyClass</code></a> and <a href="MyClass.html#foo">
<code>MyClass's foo property</code></a>. Also, check out
<a href="http://www.google.com">Google</a> and <a href="https://github.com">GitHub</a>.

相關連結

• 使用設定檔設定 JSDoc
• 使用 namepath 與 JSDoc