@see
优质
小牛编辑
129浏览
2023-12-01
说明: 更多详细信息请参阅其他一些文档。
语法
@see <namepath>
@see <text>
概述
@see标签表示可以参考另一个标识符的说明文档,或者一个外部资源。您可以提供一个标识符的namepath或自由格式的文本。如果你提供了一个namepath,JSDoc的默认模板会自动将namepath转换成链接。
例子
例如,使用@see标签:
/** * Both of these will link to the bar function. * @see {@link bar} * @see bar */ function foo() {} // Use the inline {@link} tag to include a link within a free-form description. /** * @see {@link foo} for further information. * @see {@link http://github.com|GitHub} */ function bar() {}