DocFX - 无法从 API 文档中过滤掉公共方法

Question

我的类库中有以下方法，我想从 API 文档中隐藏它：

namespace com.contoso.myns
{
    public class myclass
    {
        public static string CreateSomething()
        {
            //Do Stuff
        }
    }
}

我按照DocFX 教程过滤 API 文档来创建filterConfig.yml 。 在该文件中，我有以下内容：

- exclude:
    uidRegex: '^com\.contoso\.myns\.myclass\.Create[^.]+$'
    type: Method

但是，该方法仍然出现在我的文档中。

请注意：

• 我在filterConfig.yml中定义了其他过滤器，它们按预期工作，因此文件被 DocFX 拾取并正确解析。
• 我使用此正则表达式测试器测试了正则表达式模式 (^com.contoso.myns.myclass.Create[^.]+$)，它确实与我要排除的方法的完全限定名称匹配。

任何帮助将不胜感激。

Answer 1

匹配方法名称的模式不应包含命名空间中的整个路径； 只是方法名称本身：

- exclude:
    uidRegex: 'CreateSomething$'
    type: Method