Visual Studio 评论使用图片而不是文字

Visual Studio comments using images rather than text

在与其他项目合作数周后,我通常需要回到我几乎不记得的旧代码。

我尽量把注释写的简明扼要,但还是代码变得乱七八糟。 由于我主要在 Visual Studio C# 中使用计算机几何,我想知道是否有任何“简单”的方法来添加图像注释而不是文本?

一个评论当然可以link一个图像(例如URL)。但是不可以,您不能嵌入 图片作为评论。代码文件只是文本,不是 Word 文档。

如果问题是代码不清晰,而您依靠注释来理解它,那么解决方案不是添加更多注释。解决办法是把代码写得更清楚。给变量赋予语义上有意义的名称,将操作(每一个非常小的)提取到语义上有意义的方法中。代码本身应该准确地告诉您它在做什么。

我经常将这样的 'documentation' 放在项目子文件夹中... 然后使用本地 FILE:// URI 约定将该图像 link 放入我的代码注释或 XML 标记中。使用三重斜杠约定...当然会在智能 [=10= 中显示]