Как связать / сгруппировать перегрузки в C # XML-комментариях?

Question

В комментариях к документации XML для C # есть ли способ пометить две или более функций как перегрузочные, чтобы они автоматически ссылались друг на друга? В идеале они также должны быть как-то сгруппированы в документации, сгенерированной сандкаслом.

Цель: часто я хочу дать ссылку на эту группу функций, например, в списке служебных функций просто упомяните одну из перегрузок и сделайте другие легко обнаруживаемыми оттуда.

В настоящее время я добавляю ссылки, но это утомительно.

Answer 1

Отношения между несколькими перегрузками уже определены и сгруппированы в документации XMl и Sandcastle.

Создание ссылок на других участников с использованием тегов see или seealso.

Например.

///See <see cref="M:AnotherMethod(System.String)">

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

///See <see cref="M:MyCompany.Myapp.MyClass.AnotherMethod(System.String)">

Обратите внимание, что M: указывает на ссылку на участника, вы также используете E: для указания на Событие. T: используется для типа, но это предполагается, если не присутствует.

Answer 2

Группировка производится автоматически Sandcastle, верно, но если вы хотите дать группе перегрузки общее описание, используйте для этого тег (так же, как

). Это не стандартный тег документации XML, но AFAIR он поддерживается конструктором файлов справки Sandcastle.