2015-05-29 1 views
2

У меня есть массово перегруженный метод MethodA который ссылается сводным теге в моей документации по MethodB:Документа метод-резюме с ambigious ссылкой

/// <summary>A link to <see cref="MethodA" /></summary> 
void MethodB { ... } 

Комментарий должен не только полагаться на специальную перегрузку MethodA но и всем им. Однако компилятор печатает сообщения о том, что атрибут cref является неоднозначным (что, однако, предназначено). Есть ли какая-либо передовая практика для решения этой проблемы? Я уже думал о том, чтобы полностью удалить see -tag из summary. Может быть, у вас есть другие подходы?

+0

Что о высказывании 'Ссылка to или одна из перегрузок'? – DavidG

+0

Это будет полагаться 'MethodB' только на эту конкретную перегрузку, а не на все из них – HimBromBeere

+0

Я знаю, но я думаю, что с' see cref' вам нужно ссылаться на определенный метод, а не на группу методов. – DavidG

ответ

0

Я думаю, у вас есть 2 варианта. Либо обратиться к определенному методу в комментарии:

/// <summary>A link to <see cref="MethodA(int)" /> or one of it's overloaded variants</summary> 

В качестве альтернативы, вы можете добавить M: prefix, который удалит ошибку, хотя может быть не совсем то, что вам требуется:

/// <summary>A link to <see cref="M:MethodA" /></summary> 
+0

Я не уверен, как это работает, но это сработало. Как «М:» разрешает двусмысленность или все равно? Я только узнал, что он ссылается на метод из вашей ссылки. – HimBromBeere

+0

Я верю, что когда вы используете префикс, значения больше не проверяются на существование, хотя я не уверен на 100%. – DavidG

Смежные вопросы