在评论中链接到另一个 Python 文件答案

【问题标题】：Link to a another Python file in the comments在评论中链接到另一个 Python 文件
【发布时间】：2022-01-12 08:46:46
【问题描述】：

我正在尝试从file_1.py 创建指向file2.py 的链接。为简单起见，我们可以假设两者都在同一个包中。

我会在 Java 中（通过 Intellij）做的是使用 {@link AnotherClass}，但这在 Python 注释（或 Pycharm）中是不可能的：

我也尝试使用Sphinx，尽管可以使用:py:mod:'my.package.file2' 之类的东西建立这样的链接，但这对我不起作用，因为我无法使用 IDE 导航到文件，我也无法生成这些链接很容易，因为没有可用于自动生成完整模块路径的自动完成功能。

我还有其他选择吗？我不限于任何特定的 IDE/编辑器或任何链接格式。

【问题讨论】：

【解决方案1】：

您可以使用扩展名HTML Related Links

将此添加到您的settings.json

  "html-related-links.include": {
    "python": [
      { "find": "\\{@link ([^}]+)\\}';", "filePath": "$1.py" }
    ]
  }

现在所有链接的文件都显示在资源管理器栏中的相关文件视图中 (Ctrl+Shift+E)。您可以通过单击视图中的创建文件图标来创建尚不存在的文件。或者当您尝试打开一个不存在的文件时，您必须选择创建它（消息中的按钮）。

我将尝试使这些新类型的链接可按 Ctrl 键点击。

【讨论】：