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

Question

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

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

我还尝试过使用Sphinx，虽然可以使用类似:py:mod:'my.package.file2'的方式创建这样的链接，但这对我来说不起作用，因为我无法使用IDE导航到文件，也无法轻松生成这些链接，因为没有自动完成功能可用于自动生成完整的模块路径。

是否有其他选项我错过了？我不受任何特定IDE /编辑器或任何链接格式的限制。

- Yar

Answer 1

你可以使用扩展HTML相关链接

将此添加到你的settings.json中

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

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

我将尝试使这些新类型的链接可通过Ctrl + 单击进行点击。

- rioV8

---

听起来很有用，但这是针对Visual Studio用户的，有没有适用于PyCharm用户的呢？ - tobi delbruck

Epytext 像链接格式一样在 PyCharm 中运行良好。f""" L{bin.predict.refine_predict()} """ - riversun

@riversun，"""的作用是什么？ - rioV8

"""是Python中用于描述函数、类和模块用途和用法的文档字符串。通过在文档字符串中包含L{}符号，它可以在PyCharm中变成可通过ctrl+单击跳转的链接。 - riversun

@riversun """ 是一个文档字符串：这不是真的，请阅读文档以了解文档字符串的含义。 - rioV8