Вопросы по теме 'sandcastle'

Документация по пространству имен в проекте .Net (Sandcastle)?
Некоторое время назад я начал использовать Sandcastle для создания веб-сайта документации для одного из наших проектов. Он работает достаточно хорошо, но мы всегда писали документацию только для классов, методов, свойств (...) в нашем проекте и...
26791 просмотров
schedule 22.01.2023

Sandcastle -> Вывод в HTML -> Импорт в утилиту MOSS
Я собираюсь написать импорт в утилиту MOSS из HTML-вывода Sandcastle. Прежде чем я это сделаю, я просто хотел бы спросить, знает ли кто-нибудь об инструменте, который уже может это сделать? О, и если вопрос будет закрыт из-за того, что он не...
861 просмотров
schedule 06.10.2022

Можно ли настроить Sandcastle для создания оптимизированных для SEO страниц и ссылок?
По умолчанию я вижу, что Sandcastle создает HTML-страницы и ссылки с идентификаторами GUID. Можно ли как-то это изменить, чтобы генерировать понятные пользователю/SEO имена для страниц? Т.е. вместо f987d4ff-cabc-10af-86cd-620978605d86.htm я...
230 просмотров
schedule 17.06.2023

Примеры на нескольких языках в XML-документации
Есть ли способ включить примеры для нескольких языков (например, C# и Visual Basic) в XML-документацию? Я использую SandCastle для создания документации в стиле MSDN и хотел бы включить примеры использования для нескольких языков .NET.
1552 просмотров
schedule 02.01.2023

Строитель справки Sandcastle - SandcastleBuilder.Components.ShowMissingComponent 'не найден
ПРИМЕЧАНИЕ. Также опубликовано на веб-сайте Sandcastle Help Builder. У меня такая ошибка: BUILDASSEMBLER: ошибка: BuildAssembler: тип SandcastleBuilder.Components.ShowMissingComponent не найден в сборке компонента C: \ Program Files \...
1671 просмотров
schedule 17.07.2023

Sandcastle не добавляет документацию по параметрам
Мой метод выглядит следующим образом ''' <summary> ''' Adds the activity. ''' </summary> ''' <param name="userid">An that is derived from the <see cref="Domain.User.ID" /></param>...
1532 просмотров

Как пометить устаревшие классы/методы на выходе с помощью sandcastle
Я создаю документацию API с помощью Sandcastle. В коде есть несколько классов и методов, которые помечены как устаревшие. Теперь я хочу, чтобы в выводе API-документации эти методы были четко отмечены (перечеркнутым или другим маркером). Однако...
1095 просмотров

Как создать документацию только в формате HTML из веб-проекта aspdotnet?
Я прокомментировал весь код соответствующими тегами документации ms xml. Как создать документацию только в формате HTML (или в формате pdf) для всего закомментированного кода? Я скачал sandcastle, но не могу понять, как перейти к следующему шагу....
265 просмотров

Настройка замка из песка — переход на веб-страницу отменен
Я пытаюсь использовать Sandcastle Help File Builder, но не могу заставить его работать. Вот что я сделал: 1) установил программу; работает как обычно 2) включил xml в проекте, я хочу, чтобы документация для него создавалась в /bin 3) создал...
1010 просмотров

Как создать документацию, совместимую с IntelliSense, для сгенерированных прокси-классов WCF?
Я пытаюсь добавить документацию, совместимую с IntelliSense и SandCastle, в мои прокси-классы WCF, созданные с помощью svcutil. Есть ли способ сделать это без прямого редактирования сгенерированного кода (поскольку он будет потерян, если он...
1045 просмотров
schedule 27.01.2023

Как изменить стиль презентации Sandcastle, не меняя установочные файлы по умолчанию
В моем проекте для создания документации используются Sandcastle и Sandcastle Help File Builder. Мы используем настроенную версию script_manifold.js, которая сохраняет языковые предпочтения пользователя на всех страницах (версия по умолчанию...
2014 просмотров
schedule 21.06.2023

Замок из песка xslt
Как изменить вывод веб-сайта, созданного Sandcastle, с помощью xslt? Есть ли какие-нибудь учебники о том, как это сделать? Я могу войти и изменить css, но это кажется немного неправильным...
216 просмотров

Как настроить сервер сборки TFS2010 для создания справки с использованием SHFB
Я много гуглил, чтобы попытаться найти решение, но, похоже, я что-то упускаю. Большинство статей говорят мне, что я должен изменить файл сборки ( TfsBuild.proj ). Но нигде не могу найти этот файл. Поиск в Google немного больше говорит мне, что он...
2384 просмотров
schedule 22.05.2023

Как удалить внутренние интерфейсы со страницы справки класса, созданной с помощью Sandcastle или SHFB?
У меня есть класс, который реализует множество внутренних интерфейсов, и я бы хотел, чтобы читатель документации не видел, что класс реализует все эти внутренние интерфейсы, потому что эта информация не имеет значения для читателей. Например, если...
551 просмотров
schedule 10.10.2022

Какой синтаксис унаследовать документацию от другого индексатора?
В моей реализации у меня есть это: /// <inheritdoc cref="IInterface{T} this[,]"/> public T this[long row, long column] { ... } XMLdoc уже присутствует в IInterface . Как я могу забрать его оттуда (как и другие вещи)? Я получаю...
249 просмотров
schedule 13.09.2022

Документация C# ‹пример›‹код›‹/код›‹/пример› для класса
У меня есть класс, который я хотел бы создать простой пример того, как его использовать. Однако, когда я использую тег в объявлении класса, пример не появляется в выходных данных Sandcastle. Он отлично работает для членов объекта, но не для самого...
1893 просмотров
schedule 20.07.2023

Может ли sandcastle читать XmlDoc из внешнего файла вместо комментариев заголовка?
Sandcastle Help File Builder (SHFB) превращает комментарии с тройной косой чертой в документацию следующим образом: ///<summary>A class called Bob</summmary> public sealed class Bob {} Схема документации очень надежна. Однако,...
284 просмотров
schedule 19.05.2022

Sandcastle Help File Builder: HTML не генерируется из MAML
Я добавил файл test.aml в свой проект Sandcastle с параметром BuildAction, равным None. Я также добавил в макет файл Content Layout.content и test.aml. Когда я создаю справку (только в формате веб-сайта), тема включается в оглавление, но контента...
446 просмотров
schedule 21.07.2023

Sandcastle, / doc и неуправляемый C ++
Я работаю над проектом, который использует неуправляемый Visual C ++ и немного C #. Мы пытаемся придумать способ документировать наш проект, как справку по API, так и некоторые дополнительные концептуальные документы. В идеале вся документация...
2479 просмотров

Строитель файлов справки Sandcastle не может найти vs2010.config
Я пытаюсь создать документацию для переносимой библиотеки классов (.Net40, Silverlight 4, .Net для Windows Store, Windows Phone 7.5) в виде справки HTML 1 и средства просмотра справки MS. У меня только один «Источник документации». В проекте...
272 просмотров