Вопросы по теме 'sandcastle'
Пример кода автоматического модульного теста
Моя команда отвечает за разработку API для большой системы, которую мы также пишем. Нам нужно предоставить пример кода, чтобы другие разработчики, использующие наш API, могли научиться его использовать. Мы документировали код, используя комментарии...
1595 просмотров
schedule
28.12.2022
Получение кода модульного тестирования в XML-комментарий
Я пытаюсь прокомментировать API (.Net), который я показываю клиенту. Я делаю это с помощью комментариев XML и извлекаю их через SandCastle.
Это все прекрасно и изящно, однако у меня есть модульное тестирование API, и я подумал, что код из них было...
861 просмотров
schedule
15.05.2022
SandCastle Help Builder: функция поиска
Я очень доволен выводом SandCastle, но я также хотел бы, чтобы некоторые функции поиска были включены в вывод HTML, возможно ли это?
1603 просмотров
schedule
22.04.2023
Почему Sandcastle Help File Builder не сохраняет кэш Msdn в указанной папке?
Я пытаюсь создать документацию для своего приложения с помощью Sandcastle Help File Builder. Я добавил компонент кеша Msdn в файл .shfbproj следующим образом:
<ComponentConfigurations>
<ComponentConfig id="Cached MSDN URL References"...
605 просмотров
schedule
16.07.2022
SandCastle и OutOfMemoryException
SandCastle не может обработать нашу библиотеку классов, потому что она аварийно завершает работу с исключением OutOfMemoryException во время преобразования XSL.
Что мы можем с этим поделать, кроме очевидного, купить больше памяти? Проблема в том,...
393 просмотров
schedule
10.04.2023
Sandcastle делает различие между отладочной и выпускной сборками?
Сегодня я запустил Sandcastle Help File Builder, чтобы создать документацию для своего решения, в котором содержится около десятка проектов. Поскольку я хочу только создать документацию и запустить Sandcastle после сборки Release (которая исключает...
377 просмотров
schedule
27.06.2022
Проблемы с Sandcastle: локализация и регистр имени файла
Я использую Sandcastle Help File Builder для создания документации для проекта с открытым исходным кодом, и я столкнулся с двумя проблемами:
Содержание документации на французском языке. Я установил французский язык в проекте SHFB, но большая...
492 просмотров
schedule
06.11.2022
Исключение недопустимого символа MRefBuilder в SandCastle
Я пытаюсь использовать конструктор файлов справки Sandcastle для создания файла справки для моей сборки. Когда я запускаю сборку, я получаю следующую ошибку:
MrefBuilder (v2.4.10520.1)
Copyright c Microsoft 2006
Info: Loaded 1 assemblies for...
208 просмотров
schedule
30.11.2022
Комментарии XML - должны ли ссылки быть полностью квалифицированными?
В принципе, когда действительно необходимо (если вообще необходимо) использовать полностью квалифицированный xml, см. Ссылку:
<see cref="T:MyNamespace.Sub.MyType"/> //Option 1
<see cref="T:MyType"> //Option 2
А как насчет ссылок...
4608 просмотров
schedule
31.07.2022
Не все пространства имен включены в сборку Sandcastle для документации.
У меня есть проект C # с двумя пространствами имен в одном решении. Я задокументировал все классы / функции / члены / и т. Д. В обоих пространствах имен. Поскольку этот проект представляет собой небольшой исследовательский проект, пространства имен...
3830 просмотров
schedule
09.05.2022
Как включить пользовательские элементы комментариев к документам в файл справки Sandcastle?
В C#, если у меня есть метод добавления XML-документации, по умолчанию будет сгенерировано следующее:
/// <summary>
/// Does something
/// </summary>
public string SomeValue { get; set; }
Я хочу добавить свой собственный...
1057 просмотров
schedule
26.03.2023
Почему мои блоки кода не отображаются в файле справки Sandcastle?
Я использую текущую версию Sandcastle от Codeplex, интегрированную с VS.NET 2012, для создания файла справки .cmh . Файл справки создается, но я не могу заставить какой-либо из моих <code> блоков выдаваться в файле справки. У меня есть...
861 просмотров
schedule
19.03.2022
Как заставить Stylecop перестать жаловаться при документировании пространств имен с помощью Sandcastle?
Я пытаюсь задокументировать свои пространства имен в соответствии с рекомендациями этого ответа StackOverflow:
namespace Test
{
/// <summary>
/// The documentation for my namespace goes here.
/// </summary>...
815 просмотров
schedule
12.10.2022
Не удается создать файл справки по XML-документации с помощью Sandcastle (SHFB)?
У меня есть проект C ++ MFC только с классами и без пространства имен. Я хочу создать файл справки из XML-документации. Я пытался сделать это с помощью построителя файлов справки Sandcastle и XML-файла документа, созданного визуальной студией. Но...
1532 просмотров
schedule
22.05.2022
Можно ли создать только документацию MAML
Я пытаюсь создать справочную систему, которая (обязательно) не включает какие-либо отраженные разделы кода. Используя последнюю версию Sandcastle Help File Builder, можно ли включать только XML-файлы MAML, и какой параметр необходимо изменить, потому...
89 просмотров
schedule
26.02.2023
Как использовать IEnumerable ‹String› в документировании кода
У меня есть этот метод, по которому я пытаюсь создать документацию.
/// <summary>
/// This method demonstrates taking a Func as argument and perform that action(Func) on a list of strings.</summary>
/// <param...
2885 просмотров
schedule
20.04.2022
Установка атрибута XML для файлов Sandcastle
У меня есть проект Sandcastle, который обрабатывает для меня некоторую документацию. Я выполняю часть процесса в коде для создания файлов.
Тем не менее я хочу создать ссылку, которая будет переходить на другую страницу.
Код C#
XmlElement...
79 просмотров
schedule
29.11.2022
codeEntityСсылка на метод в разработчике SandcastleHowToDocument
Я пытаюсь создать ссылку на пользовательский метод расширения, используя элемент <codeEntityReference> MAML, и как только я создам документацию, я получаю все содержимое тега <codeEntityReference> вместо ссылки на весь метод....
873 просмотров
schedule
21.07.2023
Как я могу импортировать html или xml файл в проект Sandcastle
Я опубликовал класс из Matlab в виде файла xml и html. В другом проекте я создал файл справки с помощью конструктора файлов справки Sandcastle. Теперь я хочу включить файл html/xml в этот проект, и он должен отображаться как один файл. Это способ...
422 просмотров
schedule
23.05.2023
Sandcastle Help File Builder and Tools — ошибка: неразрешенная ссылка на сборку: mscorlib с проектом UWP Prism
В VS 2017 я установил Пакет шаблонов инструментов
Создайте проект с помощью шаблона с помощью «Приложения для гамбургер-меню Prism Toolkit»
Добавьте отсутствующие пакеты Nuget (Prism.Windows и Prism.Unity)
Скомпилируйте и запустите проект....
1471 просмотров
schedule
29.10.2023
