如何參考XML文檔C#中的class屬性？

[英]How to refer to class properties in XML docs C#?

假設我在 class 中有一個方法 這是在 PrintValueOfMyInt 上方的PrintValueOfMyInt文檔中引用MyInt成員的正確方法嗎？ 如果沒有，怎么辦？ ...

為什么我沒有收到公共 API 上缺少 xml 文檔的警告？

[英]Why am I not getting warnings for missing xml documentation on public API?

我的 C# 項目（一個 Unity Package 庫）沒有收到關於缺少公共類、屬性或方法的 xmldoc 的警告。 我想確保我所有的公共 API 在代碼中都有 XML 文檔，但我注意到有未記錄的公共方法，沒有警告。 我的 lib 的 csproj 基本上是從 Unity 自動生成的 csproj ...

XML 中的 Swagger 文檔未顯示查詢 object 參數中的架構

[英]Swagger documentation from XML doesn't show schema for in query object parameter

這個賞金已經結束。 此問題的答案有資格獲得+50聲望賞金。 賞金寬限期在19 小時后結束。 Katia正在從有信譽的來源尋找答案。 使用 REST api 的示例和 GET 方法，該方法接受 object 查詢參數。 VSCode 配置為生成 XML 文檔並將其輸入到 Swagger 中，就 ...

Visual Studio 2022 Intellisense XML 文檔開始失敗

[英]Visual Studio 2022 Intellisense XML documentation started failing

我一直在 Visual Studio 2022 中處理一個冗長而復雜的 C++ 項目，因此我一直確保盡可能多地發表評論，並且一直在為大多數函數使用 XML 文檔摘要。 這些摘要應該在編寫函數時顯示在 IntelliSense 中，然后參數摘要應該在該參數的位置顯示。 直到今天，一切都運行得很好， ...

在 XML 文檔中，如何在同一命名空間中引用另一個具有相同名稱的 class？

[英]In XML documenttion, how do I reference another class that has the same name in the same namespace?

我有幾個彼此密切相關的 C# 包。 其中每一個都有自己的IServiceCollectionsExtensions static class 位於Microsoft.Extensions.DependencyInjection命名空間中。 我想做的是在其中一個方法的 XML 注釋中，在另一個程序集 ...

JetBrains Rider - 有沒有一種簡單的方法可以生成 XML 文檔文件？

[英]JetBrains Rider - is there an easy way to generate the XML documentation file?

VS 有一個復選框，它只從 C# 構建 XML 文檔文件。 我在 JetBrains Rider 的構建設置中找不到類似的東西。 最簡單的方法是什么？ ...

DocumentationFile和GenerateDocumentationFile可以在.Net項目文件中一起使用嗎？

[英]Can DocumentationFile and GenerateDocumentationFile be used together in .Net project file?

我正在為 C# 項目編寫一個小型分析器，用於檢查 XML 文檔生成是否存在並正確設置。 有兩個選項可以指定 XML 文檔： 較舊的DocumentationFile選項更新的GenerateDocumentationFile標志。 如果該標志設置為 true MSBuild 應該在項目的 outp ...

ditamap中的主題引用數量有限制嗎

[英]Is there any limitation on the number of topic references in ditamap

DITAMAP 在 AEM 中加載 DITAMAP 儀表板中的主題引用非常緩慢，有時在有很多主題引用時會掛起。 我已經嘗試通過創建較小的 DITAMAP 並將它們引用到父 DITAMAP 中來進行隔離，但是仍然有一些內容有很多文章無法加載主題引用並且經常掛起。 有沒有關於一個 ditamap ...

Sandcastle 幫助文件生成器崩潰

[英]Sandcastle Help File Builder Crash

當您單擊編輯 API 過濾器按鈕（可見性選項卡）時，SHFB v2018.7.8.0 崩潰。 ...

C# 生成。XML 文件不包括其他文件 class

[英]C# generated .XML file not including other file class

我正在編寫 C# winforms 應用程序，我想為我的代碼創建文檔，其中包含 XML 注釋。 但是，似乎我做錯了什么，無法弄清楚它是什么。 目前，為了生成 HTML 文檔，我正在使用DocFX （但我也嘗試過sandcastle ，但結果相同）。 當創建 XML 文件和 HTML 文檔時，它似乎 ...

如何為復雜表達式添加 c# xml cref 注釋？

[英]How to add c# xml cref comment for a complex expression?

我想為表達式Bars[0].Name添加一個 cref 這是代碼，但它會生成 2 個警告 如何在不生成警告的情況下添加此 cref？ ...

代碼文檔，從常量中獲取值

[英]code documentation, get value from constant

有沒有可能，有一個常數 在 xml 評論中獲得其價值“myValue”？ 我對生成 swagger 文檔感興趣。 這是一個記錄端點的例子。 在 swagger ui 中，我實際上看到的是“Errors.BadRequestCodes.MyString”，而不是在 400 狀態代碼部分看到消息“myV ...

NDepend 查找沒有文檔的私有方法

[英]NDepend find private methods without documentation

我是 ndepend 的新手，我想要一個 cqlinq 規則來查找所有未記錄的方法。 那是我當前的查詢，但沒有記錄的屬性。 有任何想法嗎？ 新年快樂... ：-） ...

參考 XML 文檔注釋中的通用類型

[英]Reference the Generic Type in an XML Documentation comment

我有一個這樣的界面：public IApiController<T> where T: IEntity { /// <summary> /// Returns Entity with Id = <paramref name="id"/> of Cl ...

不要將NuGet包中的XML文檔文件復制到bin中

[英]Do not copy XML documentation files from NuGet packages into bin

我似乎無法找到一種方法來防止將 NuGet 包（例如 Dapper）中的 XML 文檔文件復制到 bin 文件夾中。 我正在使用 VS2015。 ...

VS Intellisense：在懸停時顯示縮進的多行代碼示例

[英]VS Intellisense: Show INDENTED multiline code example on hover-over

這樣的事情可能嗎？ 如果不清楚我在說什么，這里有一個詳細的例子： 以我幾周前寫的這個快速實用程序 class（細節省略），以及我想分享的例子為例： 我在摘要 class 上面有以下 XML： 現在，我可以發誓，當我最初創建 class 時，工具提示看起來像我想要的......但也許我產生了幻覺。 無 ...

在帶有 XML 文檔的 Visual Studio 中：如何引用其他參數？

[英]In Visual Studio with XML documentation: How to reference other param?

（就我而言，我正在 Visual Studio Community 2019 中編寫 C# 代碼以在 Unity 中使用。） 我根本找不到任何方法，除非我想通過學習如何編寫自己的 Visual Studio 擴展來 go，所以在這里我問： 問題：在編寫例如<param>時，是否可以簡 ...

.NET 核心 - System.Private.CoreLib.dll 與 System.Runtime

[英].NET Core - System.Private.CoreLib.dll vs System.Runtime

在 .NET 核心應用程序中，如果我這樣做typeof(DateTime).Assembly.Location 我得到 C:\Program Files\do.net\shared\Microsoft.NETCore.App\3.1.4\System.Private.CoreLib.dll 但是 ...

如何將 C# XML 文檔格式化為 PDF 或 static Z4C4AD5FCA2E7A3F74DBB1CED003？

[英]How can I format C# XML-documentation as PDF or static HTML?

有這個問題： How to format Visual Studio XML documentation for display on the web ，這與我想要的類似。 但是這個問題的答案都非常古老，並且提到的工具（sandcastle、docu、NDoc、AutoHelp）都已經過時並且多年 ...

可能用於 swagger 文檔的 XML 標簽/函數？

[英]Possible XML tags/functions for use in swagger documentations?

例如，我記得讀過您可以通過編寫類似於以下內容的 XML 來制作表格： 可悲的是，我不記得來源，或者它叫什么。 有沒有一個地方記錄了所有這些整潔的小東西，如果沒有，有人可以對它們有所了解嗎？ 我不完全確定以上是否是 swashbuckle 或一般 XML 獨有的。 如果是關於 XML 的一般問題 ...