我正在编写一个数学和几何密集的图形应用程序.通常,我发现虽然我尽可能地评论我的代码,但是在应用应用程序的其他部分之后,当我再次访问它时(通常用于调试),之前的注释变得难以理解.我开始认为有些情况下文本注释不会做,并且图表是必需的 - 很多都是.
我怀疑这个问题并不新鲜,我想知道其他有经验的开发人员/团队使用的技术.我发现我的许多方法可能需要至少2页的注释和图表来描述.例如,我昨天调试的一种方法处理一条线可以与三角形边相交的五种不同方式.我尽可能地评论了这个方法,但是我担心在我必须调试方法的4个月里,我精心设计的评论是没有意义的.
谢谢,
Olumide