Документирование методов расширения с помощью MAML

Question

Когда я ссылаюсь на метод в моих документах, я пишу что-то вроде этого: M:MyClass.MyMethod(System.String)

Как мне сделать то же самое, если мне нужно обратиться к методу расширения?

Answer 1

Я считаю, что mjd79 верен в том смысле, что вы будете ссылаться или ссылаться на методы расширения, используя тот же синтаксис, что и для обычных методов.

Не уверен, какой инструмент вы используете для компиляции документов, но Конструктор файлов справки Sandcastle автоматически найдет и сгенерирует раздел "Расширения" для любого класса, который имеет доступные методы расширения во время компиляции.

Я понимаю, что это полезно только для документирования расширений для вашего класса. При создании расширений для внешних классов у вас не так много вариантов, кроме включения объявления в сводке метода расширения, чтобы указать, что метод предназначен в качестве метода расширения

Прикрепленный снимок экрана с некоторой документацией, с которой я играл, но вы можете увидеть раздел Расширения:

Answer 2

Примерно так же - помните, что методы расширения - это просто статические методы в статическом классе. Так, например, если у вас есть что-то вроде этого (по общему признанию бесполезный метод):

public class StringExtensions
{
  public static string ToSingleQuotedString(this string s)
  {
    return String.Format("'{0}'", s);
  }
}

Ваша документация будет выглядеть так: M:StringExtensions.ToSingleQuotedString(System.String)

Надеюсь, это поможет.