В xml doc я могу вставить ссылку на группу методов? Как? - PullRequest
8 голосов
/ 11 сентября 2009

В C # я могу прикрепить документацию для свойств, методов, событий и т. Д., непосредственно в коде, используя Комментарии к документации XML .

Я знаю, как вставить ссылку на определенный метод:

<see cref="MethodName(TypeForArg1, TypeForArg2..)"/>

Есть ли способ вставить ссылку на группу методов ? Где у меня есть несколько перегрузок одного и того же имени метода ...

Я пытался

<see cref="M:MethodName"/>

.. но это не сработало.

РЕДАКТИРОВАТЬ: BUMP

Ответы [ 3 ]

2 голосов
/ 10 октября 2009

Видимо, нет способа сделать это.

1 голос
/ 12 августа 2013

Похоже, что это было исправлено, по крайней мере, в Visual Studio 2012:

<see cref="MethodName"/>

Сгенерирует предупреждение:

Неоднозначная ссылка в атрибуте cref: 'MethodName'. Предполагая '& hellip;', но мог бы также соответствовать другим перегрузкам, включая '& hellip;'.

Но добавление M: впереди избавляет от предупреждения:

<see cref="M:MethodName"/>
0 голосов
/ 06 июля 2018

Это теперь поддерживается в 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 не обработает комментарии.
  • Синтаксис только работает, если существует более одного метода с одинаковым именем.
  • Для этого синтаксиса нет подсветки синтаксиса или поддержки редактора.
...