|
|
|
|
|
by TeMPOraL
2734 days ago
|
|
> Kind of the whole problem is when there are weird corner cases going on that straddle function boundaries. If the problem has "hub and spokes" topology, i.e. it's relevant to multiple places in code that all reference a single location, put a comment describing the issue in that single location, and everywhere else put a comment with a reference. //Warning. See comment in [that location]. If there's no single best place for the detailed comment, put it in some design notes file, and put a comment with a reference to that file in all the affected places. DRY can, and should be, applied to comments as well. |
|