【问题标题】：JS Doc comment link methodJSDoc评论链接方法
【发布时间】：2021-09-22 15:07:39
【问题描述】：

在 JavaScript cmets 中，我想提一下某个文件中存在的方法。如何在评论中链接到该方法？例如。

说我的方法是：

function xyz() {
}

并说我正在写类似的评论

// See also {method-link to xyz}

{method-link} 应该是什么？

【问题讨论】：

标签： javascript jsdoc

【解决方案1】：

要链接到 JSDoc 中的“其他内容”，包括另一种方法，请使用 {@link ...} 标记。在您的情况下，您将使用：

// See also {@link xyz}

然后您就可以在 WebStorm 中按住 Ctrl 键并单击 xyz。

“其他”的 JSDoc 术语是“名称路径”。下面遵循 Andrew 的原始答案，其中解释了名称路径。

JSDoc3样式：

JSDoc 3 中名称路径的基本语法示例

myFunction
MyConstructor
MyConstructor#instanceMember
MyConstructor.staticMember
MyConstructor~innerMember // note that JSDoc 2 uses a dash

特殊情况：模块、外部和事件。

/** A module. Its name is module:foo/bar.
 * @module foo/bar
 */

/** The built in string object. Its name is       external:String.
 * @external String
 */

 /** An event. Its name is module:foo/bar.event:MyEvent.
 * @event module:foo/bar.event:MyEvent
 */

为了方便编码，我有时在评论中使用`markdown` 样式：

// see function name in file dir/file.name

// see the method [named of the method](file-name #method name)

【讨论】：

因此，对于我的示例，按原样放置 xyz 应该没问题。但是为什么它不像按下命令那样变成链接。我正在尝试使用 webstorm。
@Chacha：我在答案顶部添加了如何实际链接到方法。

JSDoc3样式：

JSDoc 3 中名称路径的基本语法示例

特殊情况：模块、外部和事件。

为了方便编码，我有时在评论中使用markdown 样式：

为了方便编码，我有时在评论中使用`markdown` 样式：