Могу ли я вставить ссылку на группу методов в xml-документе?Каким образом?
-
05-07-2019 - |
Вопрос
В C # я могу прикреплять документацию по свойствам, методам, событиям и так далее, непосредственно в коде, используя Комментарии к XML-документации.
Я знаю, как вставить ссылку на определенный метод:
<see cref="MethodName(TypeForArg1, TypeForArg2..)"/>
Есть ли способ вставить ссылку на группа методов?Где у меня есть несколько перегрузок с одним и тем же именем метода...
Я пытался
<see cref="M:MethodName"/>
.. но это не сработало.
Редактировать: УДАР
Решение
Видимо, нет способа сделать это.
Другие советы
Похоже, это было исправлено, по крайней мере, в Visual Studio 2012:
<see cref="MethodName"/>
Сгенерирует предупреждение:
Неоднозначная ссылка в атрибуте cref: 'MethodName'. Предполагая '& # 8230;', но могло бы также соответствовать другим перегрузкам, включая '& # 8230;'.
Но добавление M:
впереди избавляет от предупреждения:
<see cref="M:MethodName"/>
Теперь это поддерживается в Sandcastle.
Чтобы ссылаться на группу методов, требуется следующий синтаксис:
/// <summary>
/// Reference to a method group with two items:
/// <see cref="O:Full.Declaring.Namespace.TypeName.Foo"/>
/// </summary>
void Foo() { }
void Foo(int x) { }
Обратите внимание, что этот синтаксис все еще имеет некоторые ограничения, как описано этот запрос функции языка C #.
- Синтаксис не проверяется во время сборки.Сообщения об ошибках, допущенных при наборе текста, не сообщаются до тех пор, пока Sandcastle Help File Builder не обработает комментарии.
- Синтаксис Только работает, если существует более одного метода с одинаковым именем.
- Для этого синтаксиса нет подсветки синтаксиса или поддержки редактора.