xcode - 是否可以将图像添加到 Swift 中的代码注释中？

Question

基本上，我正在编写一个涉及大量三角函数和数学运算的程序，稍后必须对其进行审查。用文字解释这部分代码中发生的事情是很困难的。我想知道是否可以在代码的注释中添加图表以帮助简化解释？

谢谢!

Answer 1

如果您将代码作为 Xcode playground 发布，则可以将您的评论样式设置为具有 Markdown 格式的富文本，并添加超链接和图像。 ( Playground 是一个文件包——一个看起来像单个文件的文件夹——所以你可以把你的图像文件放在里面并从 Playground 源代码中引用它们，它们将与你的标记的其余部分内联渲染。)

如评论中所述，Apple 有 docs解释图像和其他标记的评论格式。