【发布时间】:2021-09-03 03:53:24
【问题描述】:
在与其他项目工作几周后,我通常需要回到我几乎不记得的旧代码。
我尝试简洁地编写 cmets,但代码仍然变得混乱。 由于我主要在 Visual Studio C# 中处理计算机几何,我想知道是否有任何“简单”的方法来添加图像 cmets 而不是文本?
【问题讨论】:
在与其他项目工作几周后,我通常需要回到我几乎不记得的旧代码。
我尝试简洁地编写 cmets,但代码仍然变得混乱。 由于我主要在 Visual Studio C# 中处理计算机几何,我想知道是否有任何“简单”的方法来添加图像 cmets 而不是文本?
【问题讨论】:
我经常将此类“文档”放在项目子文件夹中... 然后使用本地 FILE:// URI 约定将该图像链接到我的代码 cmets 或任何 XML 标记中……使用三斜杠约定……这当然显示在智能中
【讨论】:
评论当然可以链接到图片(例如作为 URL)。但是不,您不能嵌入图像作为评论。代码文件只是文本,而不是 Word 文档。
如果问题是代码不清晰,而您依赖 cmets 来理解它,那么解决方案不是添加更多 cmets。解决方案是更清楚地编写代码。为变量赋予语义上有意义的名称,将操作(每一个非常小的操作)提取到语义上有意义的方法中。代码本身应该准确地告诉你它在做什么。
【讨论】: