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。通常在您的API文档中不能包含private方法，这是有道理的，因为私有方法不属于您的API。

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

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

1 个答案: