Grynwald.XmlDocs 1.0.7

.NET 6.0 此代码包针对 .NET 6.0。该代码包符合此框架或更高版本的兼容性。 
dotnet add package Grynwald.XmlDocs --version 1.0.7                

                    
                

            
NuGet\Install-Package Grynwald.XmlDocs -Version 1.0.7
此命令旨在在 Visual Studio 的包管理器控制台中使用，因为它使用 NuGet 模块的 Install-Package 版本。
<PackageReference Include="Grynwald.XmlDocs" Version="1.0.7" />
对于支持 PackageReference 的项目，将此 XML 节点复制到项目文件以引用代码包。
paket add Grynwald.XmlDocs --version 1.0.7                

                    
                

            
#r "nuget: Grynwald.XmlDocs, 1.0.7"
#r 指令可用于 F# Interactive 和 Polyglot Notebooks。将其复制到交互式工具或脚本源代码中，以引用代码包。
// Install Grynwald.XmlDocs as a Cake Addin
#addin nuget:?package=Grynwald.XmlDocs&version=1.0.7

// Install Grynwald.XmlDocs as a Cake Tool
#tool nuget:?package=Grynwald.XmlDocs&version=1.0.7

Grynwald.XmlDocs

目录

概述

C# 源代码可以使用结构化注释来提供内联 API 文档。编译器将这些注释保存为 XML 文档文件。

Grynwald.XmlDocs 代码包提供了一个库将这些注释解析为 .NET 对象模型。

用法

要解析 XML 文档文件，首先在您的项目中引用 Grynwald.XmlDocs 代码包。

使用 DocumentationFile 类加载文档文件

using Grynwald.XmlDocs;

// Load XML documentation file
var documentationFile = DocumentationFile.FromFile("./MyAssembly.xml");

或者您可以直接解析单个元素，例如，要从文档文件中解析 <member/> 节点，使用

using Grynwald.XmlDocs;

var memberXml = """
    <member name="T:ExampleProject.ExampleClass">
        <summary>
            XML documentation file example
        </summary>            
    </member>
    """

var member = MemberElement.FromXml(memberXml);

要处理文档文件，库提供对访问者模式的支持。要创建访问者，直接实现 IDocumentationVisitor 或从默认实现 DocumentationVisitor 派生并重写您想要处理的文档元素的 Visit() 方法。

许可

Grynwald.XmlDocs.MarkdownRenderer 依照 MIT 许可协议授权。

详细信息请见 https://github.com/ap0llo/xmldocs/blob/master/LICENSE

产品 兼容和额外的计算目标框架版本。
.NET net6.0 兼容。 net6.0-android 已计算。 net6.0-ios 已计算。 net6.0-maccatalyst 已计算。 net6.0-macos 已计算。 net6.0-tvos 已计算。 net6.0-windows 已计算。 net7.0 兼容。 net7.0-android 已计算。 net7.0-ios 已计算。 net7.0-maccatalyst 已计算。 net7.0-macos 已计算。 net7.0-tvos 已计算。 net7.0-windows 已计算。 net8.0 已计算。 net8.0-android 已计算。 net8.0-browser 已计算。 net8.0-ios 已计算。 net8.0-maccatalyst 已计算。 net8.0-macos 已计算。 net8.0-tvos 已计算。 net8.0-windows 已计算。
兼容目标框架
已包含的目标框架（在包中）
了解更多关于 目标框架 和 .NET Standard。

  • net6.0

    • 无依赖。

  • net7.0

    • 无依赖。

NuGet 包 (1)

显示依赖 Grynwald.XmlDocs 的顶部的 NuGet 包

包 下载
Grynwald.XmlDocs.MarkdownRenderer

将 .NET XML 文档文件转换为 Markdown 的库。

GitHub 存储库

此包未被任何流行 GitHub 存储库使用。

版本 下载 最后更新
1.0.7 381 12/13/2022
1.0.6 335 12/12/2022