富文本会帮助评论代码吗？

我总是想知道为什么我必须在文本编辑器中编写富文本代码注释aka 伪代码(来吧,粗体,下划线!)并回到IDE(集成？)来编写实际程序,更不用说确保这些文件保持在代码附近.

所以问题是,如果IDE允许富文本代码注释会怎样.它会帮助任何人吗？考虑到你可以强调或强调重要点并使用标题和子标题,也许可以让阴暗的图片更清楚地理解？

(是的,我知道我们可以用*重点*和******HEADER******来管理但是让我们开箱即用!

我在谈论集成在IDE中的RTF代码编辑器.

这是一个有趣的问题,因为除了它现在是否真的是一个好主意之外,它还推动了我们工作方式的界限.

不混合富文本和代码的所有原因都没有解决这是否会对任何人有所帮助的问题 - 是否还有一个补偿缺点的上升.如果没有人提出这样的问题并发明网络,也许我们仍然会使用gopher.

至于源代码注释,一些富文本功能比其他功能更有用:

超链接肯定是有用的,因为代码文档经常需要引用代码之外的文档,以及代码中其他地方的文档链接以避免重复

图像是有用的,因为在很多情况下,最敏感的代码文档是一个图表 - 例如,有些人确实使用UML

列表将是有用的 - 例如,这个列表在其富文本版本(即HTML)中比Markdown源更容易阅读

字体格式不太重要 - 粗体和斜体偶尔对强调有用,如果代码片段(例如a variableName)在格式不同时更容易阅读,则文本更易读; 不同的颜色没有多大意义

标题通常不会有用,因为如果代码注释太长以至于需要标题来引入结构,那么它应该在代码之外.

具有讽刺意味的是,当您在Stack Overflow上发布富文本注释时,很难与代码中的富文本注释争论 - 您必须诉诸富文本"有时"的论点.

即使在这里的简短评论中,富文本结果也很有用,当您没有看到格式化版本时,Markdown源仍然是明智的.因此,对于IDE来说,将Markdown注释块渲染为富文本可能是一个很好的折衷方案,并且只要光标位置在注释块中,就会显示Markdown源.

通常,评论代码的想法是解释您的个人例程(或组件部分)要实现的操作.您不应该使用额外的格式标记这些评论以及其他人可能认为混乱的标记.

如果特定部分需要图像,重点或以其他方式需要更深入的解释,那么就表明需要发行说明或支持文档.我知道,开发人员的克星,但最好是保持整洁,易于支持.