Могу ли я добавить веб-ссылку в XML-документацию?

Question

Here Я вижу набор разрешенных XML-тегов для генерации документации (через SandCastle).

Wether существует дополнительный XML-тег для ссылки (на веб-страницу), который будет открыт через браузер при нажатии на нее пользователем? Если я использую <a href="...:/>, тогда CHM-файл пытается открыть ссылку в своем окне, и я получаю сообщение об ошибке сценария.

Answer 1

Из MSDN сообщение форума "Embedding External URLs or Hyperlinks within XML Comments": «Для того, чтобы вставить внешнюю гиперссылку, сделать так же, как вы делаете в HTML файл, например в вашем случае, вы можете добавить кредит, как это:»

/// <summary> 
/// This is a test class.See <a href="http://…">Credits</a>. 
/// </summary> 

«И инструмент справочной документации, такой как SandCastle будет обрабатывать ее должным образом.»

— пользователь Chunsheng Тан

Таким образом, использование <a> вообще кажется, что правильный путь.

К сожалению, вы не указали, какое именно сообщение об ошибке сценария вы получаете.

• Открытая веб-страница может содержать только ошибки. Если это так, вы не можете сделать ничего, кроме ссылки на другую веб-страницу.

• Средство просмотра справки может открывать веб-страницу в своем собственном браузере, где выполнение скриптов ограничено. В этом случае вы можете попробовать добавить атрибут target="_blank" к элементу <a>, чтобы веб-страница открывалась в новом окне или на вкладке.