docfx - 如何配置 docfx 以在文档中包含 C# 事件处理程序委托？

Question

我的项目中有一些事件处理程序委托，我想将它们包含到我使用docfx 自动生成的文档中。

我知道在docfx.json > 元数据中有一个过滤器选项，但是我该如何配置呢？有任何想法吗？

我尝试添加一个filterConfig.yml，并修改docfx.json，没有任何错误，但这不起作用。

C#代码：

/// <summary>
/// Double click on one row of the search result, this should open the detail form of it
/// </summary>
/// <param name="sender">Default_GridView</param>
/// <param name="e">EventArgs</param>
private void Default_GridView_DoubleClick(object sender, EventArgs e)
{
    //open the detail form here
}

docfx.json：

{
  "metadata": [
    {
      "src": [
        {
          "files": [
            "*.csproj"
          ],
          "cwd": ".",
          "exclude": [
            "**/obj/**",
            "**/bin/**",
            "_site/**"
          ]
        }
      ],
      "dest": "obj/api",
      "filter": "filterConfig.yml"
    }
  ],

filterConfig.yml：

apiRules:
- include:
    uidRegex: ^System\.EventHandler
    type: Type

Answer 1

您将不得不使您的事件处理程序方法public，protected或protected internal。通常不可能private在 API 文档中包含方法，这是有道理的，因为私有方法不是 API 的一部分。

完成此操作后，您可以删除该 API 过滤器。它会起作用的。