c# - C# 生成的 .XML 文件不包括其他文件类

Question

我正在编写一个 C# winforms 应用程序，我想为我的代码创建带有 XML 注释的文档。但是，似乎我做错了什么，无法弄清楚它是什么。目前，为了生成 HTML 文档，我正在使用DocFX（但我也尝试了sandcastle，但结果相同）。创建 XML 文件和 HTML 文档时，它似乎只包含我的主Form1.cs类（这很有趣，因为在那个特定文件中我没有任何 XML 注释）。不包括其他.cs文件（由 XML 注释组成）（它们在整个开发过程中通过 Visual Studio 添加到项目中，右键单击项目 -> 添加 -> 新项目 -> C# 类）。这是我的docfx.json：

{
  "metadata": [
    {
      "src": [
        {
          "files": [
            "*.cs"
          ],
          "cwd": ".",
          "exclude": [
            "**/obj/**",
            "**/bin/**",
            "_site/**"
          ]
        }
      ],
      "dest": "obj/api"
    }
  ],
  "build": {
    "content": [
      {
        "files": [
          "api/**.yml"
        ],
        "cwd": "obj"
      },
      {
        "files": [
          "api/*.md",
          "articles/**.md",
          "toc.yml",
          "*.md"
        ],
        "exclude": [
          "obj/**",
          "_site/**"
        ]
      }
    ],
    "resource": [
      {
        "files": [
          "images/**"
        ],
        "exclude": [
          "obj/**",
          "_site/**"
        ]
      }
    ],
    "overwrite": [
      {
        "files": [
          "apidoc/**.md"
        ],
        "exclude": [
          "obj/**",
          "_site/**"
        ]
      }
    ],
    "dest": "_site",
    "template": [
      "default"
    ]
  }
}

而且，我的文件层次结构如下所示：

如何在 XML 创建中包含其他文件？

标签： c#xmlxml-documentationsandcastledocfx

Answer 1

原因可能是没有为其生成文档的类是内部类吗？我相信默认情况下仅为公共类生成文档。