В данном примере кода я хочу сослаться на второй перегруженный метод (Int N) из C# documentation тегов:Могу ли я ссылаться на перегруженный метод, используя теги документации C#?
/// <summary>
/// The method to pass an integer to is <see cref="DoSomething">
/// </summary>
void DoSomething() {
}
void DoSomething(int n) {
}
void DoSomething(string str) {
}
Но как?
Когда ReSharper помогает мне заполнить атрибуты cref, он включает типы аргументов при перегрузках (т. Е. DoSomething(int)). Я предполагаю, что это правильный способ сделать это.
Когда Visual Studio создает файл документации XML, содержащий комментарии для связанной сборки, каждый зарегистрированный член идентифицируется уникальным именем. Вы можете проверить правила для этого поколения ID по адресу:
Processing the XML File (C# Programming Guide)
Особый интерес представляло бы правило для методов с аргументами типа основания, что говорит:
Для свойств и методов, если являются аргументами метода, список аргументов , заключенный в круглые скобки, следует за . Если аргументов нет, в скобках нет . Аргументы разделены запятыми. Кодирование каждого аргумента непосредственно следует, как он кодируется в .NET Framework подписи:
- базовых типов. Обычные типы (ELEMENT_TYPE_CLASS или ELEMENT_TYPE_VALUETYPE) - это , представленные как полное наименование .
- ...
В вашем случае приведет к идентификатору (M:YourNamespace.YourType.DoSomething(System.Int32)), которые затем могут быть использованы в cref атрибутов.
Отличная деталь. Благодарю. –
Возможный дубликат [Как сделать креф для перегрузки метода в теге в C#?] (Https://stackoverflow.com/questions/419702/how-to-make-a-cref-to-method- overloads-in-a-seealso-tag-in-c) –
binki