Справочные префиксы в документации XML XML

Question

Я пытаюсь полностью документировать все типы, методы, свойства и т. Д. Библиотеки классов, используя комментарии XML, но столкнулся с любопытным эффектом, связанным с атрибутом cref (используется тегами see например). Судя по совету this MSDN page, а также следующий различные другие примеры на MSDN и других веб-сайтах, кажется, что всякий раз, когда один задает эталонное значение, используя cref тега, он должен иметь префикс с определенным маркером, который классифицирует refence (например, «T : 'для типа и' M: 'для метода).

Использование Microsoft Sandcastle, однако, я заметил, что, упустив эти префиксы, в сгенерированной документации есть эффект (файл справки CHM в этом случае). В том числе префиксы (во всех ситуациях, которые я верю), ссылка отображается на странице в виде жирного текста ... Однако, сохраняя префикс, ссылка отображается как привязка (ссылка) к соответствующей странице в ссылке API. Мне кажется довольно странным, что рекомендуемый метод префикса (все?) Ссылки дает наименее полезный результат - почему эта ссылка должна быть выделена жирным шрифтом в одном случае и связана с другим? Я был бы признателен, если бы кто-то мог пролить свет на это.

Answer 1

Это, как представляется, был bug in sandcastle

Какой версии Сандкаслы вы используете?

Сообщалось, что, как минимум, для типов систем, предлагаемый метод заключается в том, чтобы фактически избежать использования квалифицированных имен, поскольку примеры, поставленные в этом ответе, упали на T: и M: полностью Ваша путаница поэтому не является неожиданностью или редко.

This documentation настоятельно предполагает, что компилятор, где он может определить, какой тип/метод/константа вы указываете, вставляет вам префиксы. Вы проверили это в xml?