DocFX - Невозможно отфильтровать метод publi c из документации API - PullRequest
0 голосов
/ 27 января 2020

В моей библиотеке классов есть следующий метод, который я хочу скрыть из документации API:

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

Я следовал DocFX Tutorial для фильтрации документации API , чтобы создать filterConfig.yml . В этом файле у меня есть следующее:

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

Однако этот метод все еще встречается в моей документации.

Обратите внимание:

  • У меня есть другие фильтры определены в filterConfig.yml , которые работают как и ожидалось, поэтому файл выбирается и правильно анализируется DocFX.
  • Я протестировал шаблон регулярного выражения (^ com.contoso.myns.myclass.Create [^.] + $), используя этот тестер регулярных выражений , и он соответствует полному имени метода, который я хочу исключить.

Любая помощь будет принята с благодарностью.

1 Ответ

0 голосов
/ 27 января 2020

Шаблон для соответствия имени метода не должен содержать весь путь из пространства имен; только само имя метода:

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