一種鏈接到類，方法，特別是C＃中特定代碼行的方法註釋

我想使用指向目標的代碼中的鏈接構建排序文檔。目標可以是Class或Method或特定的代碼行。（指向特定的代碼行是最重要的）
我想到了VS2010或特定評論標籤的擴展。
有什麼辦法可以製作這種鏈接嗎？一種鏈接到類，方法，特別是C＃中特定代碼行的方法註釋

來源

2012-10-07 HichemSeeSharp

Javadoc能夠正是這樣的事情。當微軟發佈.Net 1.1時，他們試圖用「NDoc」模仿Javadoc。然後殺死NDoc以支持「Sandcastle」：http://weblogs.asp.net/fmarguerie/archive/2006/02/16/ndoc-project-stalled-no-version-2-microsoft.aspx。坦率地說，他們目前的XML事情是一團糟......建議：考慮使用[Doxygen]（http://www.stack.nl/~dimitri/doxygen/）。 – paulsm4

@HichemC，試試[這]（http://hyperaddin.codeplex.com/） –

我剛試過，我認爲它工作正常 - 只需註冊加載項並閱讀Help.htm以瞭解如何使用它。如果你有任何問題（因爲它是爲VS 2005和2008構建的），你可以重建解決方案（它是開源的），它應該可以正常工作。 –

Xml評論+ sandcastle可能是你需要的。您可以參考指定的類或方法使用

<see cref=".."/>

和參考參數使用

<paramref name=".."/>

但是，沒有引用的某些代碼行直接的方法，但你可以通過使用

參考一定的#region

<code source="$sourcefile$" region="$regionname$"/>

請參閱：XML Comments Guide第20頁

請注意，您引用的代碼將直接顯示在適當的位置，而不是鏈接。這並不完美，但我希望它有幫助。

來源

2012-10-15 12:57:17 Liu

很有幫助的答案。謝謝 – HichemSeeSharp

一種鏈接到類，方法，特別是C＃中特定代碼行的方法註釋

回答

相關問題