xml-documentation

    19熱度

    6回答

    我總是用C#xml語法爲類和方法編寫漂亮的代碼註釋。我總是期望能夠輕鬆地在稍後導出它們。 今天我真的必須這樣做,但我很難找出如何。有什麼我失蹤?我想去菜單 - >構建 - >構建代碼文檔,但沒有選擇那樣做,那裏。

    6熱度

    3回答

    如何在.Net中內嵌文檔成員?讓我解釋。大多數從註釋中提取文檔的工具都支持某種內聯文檔,您可以在成員聲明後添加摘要。就像: public static string MyField; /// <summary>Information about MyField.</summary> 有沒有辦法在C#或.NET語言中做到這一點?

    7熱度

    1回答

    我想知道是否有可能在註釋中引用動態泛型類名並使其在IDE中有條件地解決? 簡單基類,例如: // <summary> // Retrieves all <T> members from the database. // </summary> public void GetAll<T>() { //magic } 如果我現在從該類繼承和恰好是類用戶然後我想有智能感知顯示我的意見是「檢

    7熱度

    4回答

    我正在記錄一個使用XML Documentation Comments的程序集,其中將使用Sandcastle創建一個chm文件。 我的程序集包含各種接口,每個接口都由一個類實現(在我的場景中是WCF服務)。 我已經添加了文檔的接口,有沒有什麼辦法讓我自動在實現類上記錄相關的方法?

    22熱度

    3回答

    我在MSDN鏈接中看到如「CompareOrdinal Overloads」。我如何在C#中編寫這樣的鏈接? 我想: <seealso cref="MyMethod">MyMethod Overloads</seealso> 但是,編譯器給了我一個關於是對於具有其他重載方法不明確的引用警告。 (初級問題:我是不是真的需要寫這個標籤鏈接到重載,抑或是自動文檔處理器產生的?)

    2熱度

    1回答

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

    1熱度

    1回答

    這個問題源於這個問題 Code documentation how much is too much? 一個答案是保持你的XML文檔在一個單獨的文件。我真的很喜歡這個答案,因爲當我仔細查看代碼時,文檔的冗長是煩人的,另一方面,當通過智能感知或發佈文檔搜索正確的方法時,冗長是有用的。 答案是使用包括標籤 /// <include file="Documentation/XML/YourClass.x

    77熱度

    9回答

    是否有自動方式來同步接口和其實現之間的註釋? 我目前正在記錄它們,並且不想手動保持它們同步。 更新:當我創建一流這樣 interface IFoo{ /// <summary> /// Commenting DoThis method /// </summary> void DoThis(); } class Foo : IFoo { publ