Я использую текущую версию Sandcastle от Codeplex, интегрированную с VS.NET 2012, для создания файла справки .cmh
. Файл справки создается, но я не могу заставить какой-либо из моих <code>
блоков выдаваться в файле справки. У меня есть следующий простой пример, с которым я продолжаю работать:
/// <summary>
/// This is the summary
/// </summary>
/// <code>var s;</code>
public string SomeValue { get; set; }
Когда я смотрю на выходной файл .chm, код var s;
отсутствует нигде. Я сделал следующее:
- Добавлена ссылка на
Code Block Component
в свойствах проекта Sandcastle. - Пробовал создавать теги
<code lang="C#">var s;</code>
и<code language="C#">var s;</code>
, но ничего не изменилось. - Прочитайте документацию на следующих сайтах, подробно описывающую этот процесс, но безрезультатно:
https://www.simple-talk.com/dotnet/.net-tools/taming-sandcastle-a-.net-руководстводляпрограммистовподокументированиювашегокода/
http://www.ewoodruff.us/shfbdocs/
Пример, очевидно, является упрощенной версией, но я просто пытаюсь заставить работать основы. Что я делаю неправильно или упускаю?
code
может быть сам по себе, попробуйте поместить его внутри тега<example>
, например<example><code>var s;</code></example>
. - person vcsjones   schedule 19.03.2013