Я пытался полностью документировать все типы, методы, свойства и т. Д. Библиотеки классов, используя комментарии XML, но натолкнулся на любопытный эффект, связанный с атрибутом cref (например, используемым тегами see) , Исходя из рекомендаций этой страницы MSDN , а также следуя различным другим примерам на MSDN и других веб-сайтах, создается впечатление, что всякий раз, когда указывается эталонное значение с помощью тега cref, перед ним должно стоять маркер, который классифицирует ссылку (например, «T:» для типа и «M:» для метода).
Однако, используя Microsoft Sandcastle, я заметил, что, пропуская эти префиксы, вы получаете эффект в сгенерированной документации (в данном случае в файле справки CHM). Включая префиксы (во всех ситуациях, я верю), ссылка отображается на странице жирным шрифтом ... Тем не менее, исключая префикс, ссылка отображается как привязка (ссылка) к соответствующей странице в ссылке API. Мне кажется довольно странным, что рекомендуемый метод префикса (всех?) Ссылок дает наименее полезный результат - почему в одном случае ссылка должна быть выделена жирным шрифтом и связана в другом? Буду признателен, если кто-нибудь сможет пролить свет на это.