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

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

comments graphics

4

Olumide · 技术社区 · 16 年前

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

谢谢,

奥卢胺

3 回复 | 直到 16 年前

1

6

northpole 16 年前

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

2

3

Scoregraphic 16 年前

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

3

1

Adrian McCarthy 16 年前

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

总是有ASCII艺术!