主页 / 问题 / 1264466
Accepted
JamesBondCaesar
Asked:2022-04-01 00:22:21 +0000 UTC2022-04-01 00:22:21 +0000 UTC

如何从 XML 注释生成 HTML 文档页面？

  • 772

如何为 XML 注释生成文档？

DocFX，他们写道它可以做到这一点，但我找不到关于如何将 XML 文档连接到它的手册，以便它在网站页面的 HTML 中自动生成。

有什么其他方法可以用于此？

документация

1 个回答

  1. Best Answer

    DocFX 的此类手册在这里：https ://dotnet.github.io/docfx/tutorial/walkthrough/walkthrough_create_a_docfx_project_2.html

    要将 XML 文档连接到 DocFX 站点，您需要将项目的 *.csproj 添加到源（以便从源中获取文档）或收集的 *.dll 文件（以便从*.xml 文件由 DLL 旁边的编译器生成）。第一种方法通常更好，但它需要在文档构建机器上安装 Visual Studio 2019，即使项目本身来自旧版本。

    下面是一个使用 XML 文档的示例 docfx.json：

    {
  "metadata": [
    {
      "src": [
        {
          "files": ["*.dll"],          
          "src": "MyLib/bin/Debug/"
        }
      ],
      "dest": "api"      
    }
  ],
  "build": {
    "content": [
      {
        "files": [
          "api/**.yml",
          "api/index.md"
        ]
      },
      {
        "files": [
          "articles/**.md",
          "articles/**/toc.yml",
          "toc.yml",
          "*.md"
        ]
      }
    ],
    "resource": [
      {
        "files": [
          "images/**"
        ]
      }
    ],
    "overwrite": [
      {
        "files": [
          "apidoc/**.md"
        ],
        "exclude": [
          "obj/**",
          "_site/**"
        ]
      }
    ],
    "dest": "docs",
    "globalMetadata": {
      "_appTitle": "My Lib"
    },
    "globalMetadataFiles": [],
    "fileMetadataFiles": [],
    "template": [
      "default"
    ],
    "postProcessors": [],
    "markdownEngineName": "markdig",
    "noLangKeyword": false,
    "keepFileLink": false    
  }
}

    在这里，文档的源数据是目录中所有 DLL 的 XML 文件、MyLib/bin/Debug/articles 目录中的 .md 文件和 images 目录中的图像。（尽管在 json 中 DLL 被认为是源文件，但实际上信息将从 XML 文件中获取。）

    要基于项目生成，需要将元数据部分更改如下：

    "metadata": [
    {
      "src": [
        {
          "files": [
            "MyLib/**.csproj"
          ],
          "exclude": [
            "**/bin/**",
            "**/obj/**"
          ]
        }
      ],
      "dest": "api"
    }
  ]
    • 1

相关问题