當文本評論不會做什麼時使用什麼？

Question

我正在寫一個數學和幾何密集的圖形應用程序。通常，我發現雖然我儘可能最好地評論我的代碼，但在應用程序的其他部分工作一段時間後，以前的評論在重新訪問時（通常用於調試）變得難以理解。我開始認爲有些情況下文本評論不會做，而且圖表是必需的 - 很多都是。

我懷疑這個問題並不新鮮，我想知道其他有經驗的開發人員/團隊如何使用哪些技術。我開始注意到我的許多方法可能需要至少2頁的筆記和圖表來描述。例如，我昨天調試過的一種方法處理一條線可以與三角形邊相交的五種不同方式。我盡我所能地評論了這種方法，但是我擔心，如果我必須調試方法，4個月內我的精心製作的評論就沒有意義了。

感謝，

Olumide

Answer 1

的情況並不少見，包括自述文件或其他類型的幫助文件與程序。例如，這些其他類型可能是包含圖表的PDF。您可以註釋您的代碼以引用包含的幫助文件。

Answer 2

在這種情況下，我指的是描述圖形問題的外部文檔（很可能是pdf）。我很可能在註釋部分（.NET世界）中使用<see>標記。請參閱http://msdn.microsoft.com/en-us/library/acd0tfbe.aspx

Answer 3

如果該算法在Web上的某處進行了描述，請在註釋中包含一個URL以補充代碼中的註釋。

而且總是有ASCII藝術！