xml-comments

1熱度

1回答

我以前曾經遇到過這種情況。我希望在我的XML註釋中引用一個類型，但該類型包含在未由我的項目引用的程序集中。在A.DLL（引用B.DLL）： using B; ///<summary>Hai I'm SomeClass and I use <seealso cref="B.LoserClass"/> to do my work</summary> public class SomeClass

15熱度

6回答

C＃編程的XML註釋提示

早上好，下午，傍晚或晚上（取決於您的時區）。這僅僅是關於C＃中的XML註釋一個一般性的問題。我從來沒有對評論我的程序過大，我一直是一個詳細的變量/屬性/方法的名字，讓代碼自己說話。如果我編寫了一些相當混亂的東西，我會寫評論，但大多數情況下我不會寫很多評論。我正在做一些關於.NET，Sandcastle和codeplex上的幫助文件構建器的XML註釋的閱讀，並且它讓我想要記錄我的代碼併爲那些擁有

18熱度

3回答

更改默認XML註釋片段

當我在Visual Studio中打///，是有可能得到的片段從： /// <summary> /// /// </summary> 這個？： /// <summary></summary>

6熱度

4回答

尋找失蹤的XML註釋

縱觀或C＃源代碼中我們有很多的未命中的實際內容，像這樣的評論： /// <summary> /// </summary> 或本： /// <summary> /// /// </summary> 或這樣的： /// <param Name="flag"></param> 不幸的是Visual Studio不會爲這類缺少的註釋產生警告。但是對於我們來說，如果我們可以在Visual

6熱度

2回答

如何在C＃XML註釋中鏈接/分組重載？

在C＃的XML文檔註釋中，有沒有辦法將兩個或多個函數標記爲彼此的重載，以便它們自動引用對方？理想情況下，它們也會以某種方式分組在沙堡生成的文檔中。目的：通常，我想鏈接到這組函數，例如，在效用函數列表中，只需提及其中的一個重載，並使其他人很容易從那裏發現。目前我正在添加鏈接，但那很乏味。

1熱度

1回答

框架goto定義顯示註釋，這些是從xml註釋生成的嗎？

最近我發現我的精心製作的xml評論沒有出現在我的同事的智能感知中，我感到很詫異。一直使用關聯的程序集和項目引用，我沒有意識到你必須導出.xml文檔以訪問這些信息。這讓我想知道.Net框架intellisense如何工作。如果我理解正確，那麼.xml文件必須隱藏在特定文件夾的某個位置？但我的主要問題是關於'轉到定義' - 如果你定義了一個.Net框架程序集，你可以從元數據生成信息 - 但也有很多

26熱度

2回答

XML註釋中的filterpriority標籤有什麼作用？

我已經在.NET Framework BCL中的許多類的XML註釋中看到了這一點，但從來沒有找到解釋它做什麼的文檔。舉個例子，看着System.Object的揭示了以下意見： namespace System { /// <summary>Supports all classes in the .NET Framework class hierarchy /// and p

14熱度

3回答

在C＃中使用C＃的xml註釋cref屬性

在C＃中，我嘗試使用<請參閱cref =「blah」/ >以引用包含params關鍵字的方法簽名。我知道這將參數列表轉換爲數組，但我甚至無法弄清楚如何引用CREF屬性中的數組。我在搜索中找不到任何東西，也沒有人知道我有任何想法。編譯器在方括號中窒息。我嘗試了各種不同的組合，使用花括號，使用Array類，但沒有任何工作。有人知道嗎？

2熱度

1回答

參考前綴在.NET中XML文檔

我一直在試圖完整記錄所有類型，使用XML註釋，但遇到了涉及cref屬性的奇怪現象方法，屬性等一個類庫（使用see標籤例如）。通過this MSDN page的建議以及MSDN和其他網站上的各種其他示例，似乎每當使用cref標籤指定參考值時，它都必須以用於分類refence的特定標記作爲前綴（例如'T ：'用於類型，'M：'用於方法）。但是，我發現使用微軟Sandcastle時，由於錯過了這些前綴

2熱度

6回答

XML評論：要用還是不用？

我的同事很少（如果有的話）在使用我們的軟件時使用XML註釋（我不能說我更好）。我最近看到了使用它們的好處，但是如果它們正在記錄的代碼是清晰寫入的（表達性/描述性變量/函數名稱，一些在線評論），它們真的值得嗎？謝謝！