一个想法刚刚出现在我的脑海中。有什么方法可以在代码注释中插入图片来帮助解释我们的代码吗?毕竟,一张图抵得上一千个字。
由于我使用 Emacs,到目前为止是否有 Emacs 的实现?
看一下iimage-mode
:这是在文本缓冲区中显示图像的标准解决方案。
例如,给定以下文件:
/* an image is worth a thousand words:
* <path/to/image.png>
*/
int main (int argc, char **argv) {
return 0;
}
然后运行M-xturn-on-iimage-mode
应该显示image.png
在其路径的位置。
但是,我同意@user4815162342 的评论,即您需要将图像与源文件一起分发,并记住在需要时更新它们(有时很难更新代码注释,因为它们只是文本;IMO 更难更新图像注释)
您是在谈论 ASCII 图形还是实际图像?
对于 ASCII 艺术,M-x artist-mode
它允许您绘制简单(或不太简单)的图像。此外,如果您需要绘制基于 ASCII 的 UML 图,CEDET可以为您完成。
对于插入实际图像,有很多函数,如create-image和insert-image,因此编写一个将图像插入评论的次要模式应该很简单。不过,我不知道有任何现成的解决方案。