@see

标准化	扩展
语法种类	块标签

用法

用于构建与当前项目相关的 API 项目或其他资源的引用列表。

注意：JSDoc 尝试自动超链接 @see 之后的文本。由于这与纯文本有歧义，TSDoc 而是要求显式的 {@link} 标签来创建超链接。

示例

/**
 * Parses a string containing a Uniform Resource Locator (URL).
 * @see {@link ParsedUrl} for the returned data structure
 * @see {@link https://tools.ietf.org/html/rfc1738|RFC 1738}
 * for syntax
 * @see your developer SDK for code samples
 * @param url - the string to be parsed
 * @returns the parsed result
 */
function parseURL(url: string): ParsedUrl;

@see 是一个块标签。每个块都成为引用列表中的一个项目。例如，文档系统可能会将上述块呈现如下

`function parseURL(url: string): ParsedUrl;`

Parses a string containing a Uniform Resource Locator (URL).

## See Also

- ParsedUrl for the returned data structure
- RFC 1738 for syntax
- your developer SDK for code samples

另请参阅

• RFC #235: @see 块标签指定“另请参阅”部分的项目