gajus/eslint-plugin-jsdoc

Rule suggestion: enforce proper `@see` + `@link` syntax for hyperlinks

Open

#1,631 创建于 2026年1月20日

在 GitHub 查看
 (1 评论) (4 反应) (0 负责人)JavaScript (172 fork)github user discovery
enhancementhelp wanted

仓库指标

Star
 (1,215 star)
PR 合并指标
 (PR 指标待抓取)

描述

Motivation

As of filing, I know of two syntaxes for saying a user can @see a link:

  • At-Linked: @see {@link https://example.com|Example}
  • Markdown: @see [Example](https://example.com)

For consistency's sake, I think it would be nice to have a lint rule to prefer one and auto-fix the other to it.

Current behavior

No lint rule enforces either.

Desired behavior

I'm not sure. The Markdown variant is fewer characters, but the At-Linked one seems to be more of a "proper" link through JSDoc @link, so perhaps that?

Both show up well in at least TypeScript's native intellisense. The Markdown variant isn't perfectly supported by VS Code's native syntax highlighter, but that strikes me as a bug and not a motivator for choosing one over the other.

Alternatives considered

🤷

贡献者指南