image - 如何将简单的图表放在代码注释中？

Question

我可能是一个非常直观的思想家。当我编写相对复杂的代码时，我希望在源代码中有一个快速图表，以帮助读者。

我有时会求助于“ascii 艺术”。例如，如果我正在描述网络中的流程，我可能会在函数的注释中包含：

例如

  #      {target, img}   
  #            |
  #            | policy()
  #            |
  # ^         action          
  # |        /     \ drw()     |
  # | AFM() |    newimage      |
  # |        \    / enc()      V
  #           z_new        mu
  #                \      /
  #                  Loss

总的来说，我觉得代码注释有时会受益于在其中嵌入图片或图像。如果您使用文档工具生成 HTML 文档，我想有办法做到这一点。但是有没有工具可以在代码文件中包含这个？这里有一些选项

• IDE 显示的链接 PNG 或 SVG
• 注释内的 SVG（在 IDE 中嵌入绘图工具）
• ascii 艺术 - 例如使用 IDE 插件绘制
• 评论中的其他绘图标记？

PS 我正在使用 Python/Spyder，但同样的问题也适用于其他 IDE/语言组合。如果这不适用于 StackOverflow，请道歉 - 如果不是，请移至适当的位置。

标签： imagecommentsmarkupdocstring