Описание тега sandcastle
Sandcastle создает точную, исчерпывающую документацию в стиле MSDN, анализируя исходные сборки и, при необходимости, интегрируя комментарии к документации XML.
2
ответа
Как заставить Stylecop перестать жаловаться при документировании пространств имен с помощью Sandcastle?
Я пытаюсь задокументировать свои пространства имен, как рекомендовано в ответе Stackru: namespace Test { /// <summary> /// The documentation for my namespace goes here. /// </summary> [System.Runtime.CompilerServices.CompilerGenerated] i…
02 июл '13 в 00:01
2
ответа
Пример кода XML документации Sandcastle без возврата каретки
Я использую sandcastle для документирования в API веб-сервиса и для сводок и замечаний к пространству имен верхнего уровня. Я добавил файл sandcastle.xml в свой проект. Моя проблема заключается в том, что когда я пытаюсь добавить пример кода xml в р…
21 мар '12 в 03:11
1
ответ
Sandcastle ссылки на интерфейс C# со страницы приветствия
Я успешно создал файл справки моего решения C# с помощью проекта SandCastle. В проекте SandCastle есть страница приветствия. Я хочу иметь ссылку с этой страницы приветствия на страницу в файле справки. Документация Sandcastle по ссылкам говорит, что…
01 мар '17 в 22:54
1
ответ
Неразрешенная ссылка на сборку с замком из песка
Я пытаюсь сгенерировать документацию с помощью конструктора файлов справки sandcastle. При создании проекта в замке из песка я получаю следующую ошибку. MRefBuilder : error : Unresolved assembly reference: Microsoft.Owin (Microsoft.Owin, Version=2.1…
23 мар '15 в 06:47
1
ответ
Построитель файлов справки Sandcastle не может найти vs2010.config
Я пытаюсь создать документацию для переносимой библиотеки классов (.Net40, Silverlight 4, .Net для Магазина Windows, Windows Phone 7.5) в виде HTML Help 1 и MS Help Viewer. У меня есть только один "Источник документации". Проект настроен на использо…
23 мар '13 в 17:55
2
ответа
Сгенерированный index.html в Sandcastle включает только первый проект
Я использую Sandcastle Help File Builder для документирования проектов в решении C#. У меня есть генерирование HTML Help 1, а также веб-сайт Сгенерированный файл HTML Help 1 (.chm) в порядке, поэтому я знаю, что базовый процесс сборки документации р…
29 июл '14 в 18:30
3
ответа
Комментарии XML - Документация MSDN Раздел "Примечание" - как вы продублируете это?
По сути, в онлайн-справке MSDN я часто сталкиваюсь с разделом "ПРИМЕЧАНИЕ", но никак не могу понять, как получить такой же вывод. Видимо нет <note> тег. Кто-нибудь знает, как заставить это работать? IDictionary (TKey, TValue) - в этом примере,…
12 сен '11 в 20:28
1
ответ
Почему Sandcastle Help File Builder не хранит кэш Msdn в указанной папке?
Я пытаюсь собрать документацию для своего приложения, используя Sandcastle Help File Builder. Я добавил компонент кэша Msdn в файл.shfbproj следующим образом: <ComponentConfigurations> <ComponentConfig id="Cached MSDN URL References" enable…
24 мар '09 в 08:38
1
ответ
Как я могу импортировать html или xml-файл в проект Sandcastle
Я опубликовал класс из Matlab в виде XML и HTML-файла. В другом проекте у меня есть файл справки с помощью конструктора файлов помощи Sandcastle. Теперь я хочу включить html/xml файл в этот проект, и он должен быть показан как один файл. Это способ …
21 июн '16 в 07:56
1
ответ
Как я могу предоставить документацию с XML-комментариями, не нарушая читабельность в браузере объектов?
Я работаю над улучшением некоторых наших комментариев к исходному коду, чтобы улучшить качество сгенерированных SandCastle справочных документов по библиотекам классов, добавив дополнительные записи, такие как или с /// <summary> /// Represent…
27 мар '12 в 17:12
2
ответа
Как я должен документировать унаследованных членов?
Учтите, что у меня сложная структура классов, в которой многие элементы наследуются от других элементов. У меня может быть метод GetStuff(string stuffName, int count) определяется в интерфейсе, который наследуется другим интерфейсом, который затем р…
21 авг '10 в 03:32
1
ответ
Сводная информация не появилась в документации с помощью построителя файлов справки Sandcastle (SHFB)
Я использовал Sandcastle для документирования своего приложения на C# для рабочего стола. Я использую Sandcastle Help File Builder (SHFB) и включил файл *.sln или *.csproj, чтобы извлечь информацию и сделать ее в виде файла документации *chm. Он ско…
05 авг '12 в 20:20
1
ответ
Sandcastle не добавляет параметры документации
Мой метод выглядит следующим образом ''' <summary> ''' Adds the activity. ''' </summary> ''' <param name="userid">An that is derived from the <see cref="Domain.User.ID" /></param> ''' <param name="activity">The ac…
27 дек '10 в 00:38
1
ответ
Как я могу узнать, что вызывает различия в сгенерированных документах Sandcastle?
В Noda Time мы генерируем нашу документацию, используя Sandcastle и SHFB. Затем мы фиксируем документацию обратно в исходный репозиторий - прежде всего потому, что это облегчает просмотр последних (и исторических) документов. Я являюсь основным разр…
16 фев '13 в 19:27
1
ответ
SandCastle и OutOfMemoryException
SandCastle не может обработать нашу библиотеку классов, потому что она аварийно завершает работу с исключением OutOfMemoryException во время преобразования XSL. Что мы можем сделать с этим, кроме очевидного, купить больше памяти? Проблема в том, что…
20 июл '09 в 08:05
0
ответов
Sandcastle скрыть, что ваш класс наследует другой класс в подписи ("подпись класса")
Я документирую свой API и хочу скрыть, что один из моих классов наследует базовый класс. пример public class Foo:FooBaseClass, Это текущее отображение в моей HTML-документации. Однако я хочу показать это так public class Foo, Мне удалось скрыть унас…
01 янв '18 в 21:31
2
ответа
Как создать документацию только для HTML из веб-проекта aspdotnet?
Я прокомментировал весь код с соответствующими тегами документации MS XML. Как создать документацию только для HTML (или pdf) для всего прокомментированного кода? Я скачал sandcastle, но не могу понять, как перейти к следующему шагу. Спасибо!
07 мар '11 в 07:49
1
ответ
Как лучше всего создать страницу справки?
Я видел несколько постов о различных решениях, таких как Sandcastle для документирования кода. Однако мне интересно, есть ли решение, разработанное для не-разработчиков. Будет ли такое решение, как Sandcastle, NDoc или GhostDoc, лучше всего подойдет…
29 фев '12 в 10:01
2
ответа
Самый простой способ добавить XML документ в проект WinRT
У нас есть группа разработчиков, которая переходит с C++ на C# и WinRT. Мы использовали D'Oxygen в качестве части наших сборок для разработчиков на C++, и я хотел бы продолжить создание документов в рамках сборки для разработчиков на C#/WinRT. Включ…
06 фев '13 в 21:29
3
ответа
$(SolutionDir) Свойство MSBuild неверно при запуске построителя файла справки Sandcastle через CMD
Когда я запускаю файл проекта Sandcastle Help File Builder (например, myproject.shfbproj), используя Windows CMD, я получаю раздражающую проблему: $(SolutionDir) имеет то же значение, что и $(ProjectDir), и это означает, что исходные тексты документ…
07 сен '15 в 09:45