XML-документация <code>тег показывает C # для кода VB.NET - PullRequest
4 голосов
/ 28 июля 2011

Я пытаюсь использовать тег внутри тега , чтобы показать пример кода в документации XML.Однако когда я строю проект Sandcastle, я вижу, что он отображается как C #.В теге нет языкового атрибута.И я не смог найти настройку в свойствах проекта Sandcastle.Я что-то упустил?

Кстати, я использую формат HtmlHelp1.

1 Ответ

11 голосов
/ 30 июля 2011

На самом деле, если вы перейдете за пределы Sandcastle на Конструктор файлов справки Sandcastle (SHFB), вы получите и более простой в использовании интерфейс для Sandcastle и дополнительныефункции для вашего набора документации, включая то, что вы хотите: атрибут языка (language) для элемента <code>.

Обратите внимание, что SHFB создает меню выбора языка, но позволяет только отображать или скрыватьопределенный набор языков (C #, VB.NET, C ++, J #, JScript.NET, XAML и JavaScript).Однако он поддерживает раскрашивание большего набора (C #, VB.NET, JScript.NET, C ++, J #, C, JavaScript, VBScript, XAML, XML, HTML, сценарий SQL, сценарий PowerShell и Python).(Из раздела Компонент кодового блока документации SHFB.)

Я много писал об этом, а также о многих других советах и ​​подводных камнях Sandcastle и SHFB в моей статье Укрощение Sandcastle: Руководство программиста .NET по документированию вашего кода опубликовано на Simple-Talk.com.Помимо основной статьи, я также собрал настенную диаграмму / краткую справку , которая дает вам все, что вам нужно знать для использования Sandcastle / SHFB на одной странице - ссылка также появляется в конце статьи.

Более подробную информацию об элементе <code> можно найти в разделе Отображение образца кода моей статьи, а также в официальной документации SHFB по адресу Импорт и раскраска кода из исходного кода.файлы .

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...