代码之家 › 专栏 › 技术社区 › Olumide

当文本评论不起作用时,该怎么办?

comments graphics

Olumide · 技术社区 · 17 年前

我正在写一个数学和几何密集型的图形应用程序。我经常发现,尽管我尽可能地注释了我的代码,但在处理了应用程序的其他部分一段时间后,当我重新审视它时(通常是为了调试),之前的注释变得很难理解。我开始认为,在某些情况下,文本注释是行不通的,需要图表——很多图表。

谢谢,

奥卢胺

3 回复 | 直到 17 年前

northpole 17 年前

在程序中包含自述文件或其他类型的帮助文件并不罕见。例如,这些其他类型可以是包含图表的PDF。您可以注释代码以引用包含的帮助文件。

Scoregraphic 17 年前

在这种情况下,我会参考一份外部文档(最有可能是pdf),其中描述了图形的问题。我最有可能使用 <see> 注释部分中的标记(.NET世界)。看 http://msdn.microsoft.com/en-us/library/acd0tfbe.aspx

Adrian McCarthy 17 年前

如果该算法在网络上的某个地方进行了描述,请在注释中包含一个URL,以补充代码中的注释。

总是有ASCII艺术!

推荐文章

Vojtjikjhh -4K- · 绘制光标问题

2 年前

FoolishMortal · 无法显示从基64字符串解码的特定图像

2 年前

Dromlius · JPanel透支重叠的JComcoBox

2 年前

mathInferno · 另一个OpenGL纹理未渲染后

2 年前

Pierro · 当我运行一个简单的SFML代码时,为什么像素会失真?

2 年前

Unknown · Were我能找到游戏横幅psd文件吗[关闭]

3 年前

Skywalker00111 · Google Colab中的可视化图形

3 年前

se-tima · 如何绘制微生物学结果图(生长曲线)?

3 年前

user1944491 · 如何在静态基线上绘制SwiftUI矩形?

3 年前

danglingPointer · 如何在自定义过程中渲染基本的GameObject(Unity:ScriptableRenderPass)?

3 年前