Все вопросы: [sandcastle]

41 вопросов

похожие теги:
2
голосов
1ответов
1355 просмотров

Can I programmatically export class diagrams from Visual Studio 2008?

I can export a class diagram as an image from Visual Studio by right-clicking on the surface and choosing "Export Diagram as Image..." Is there a way to do this through command line? I'd like to be able to generate all of my class diagrams as images so I can include it in the .chm I am build...

2
голосов
1ответов
1038 просмотров

What is the proper way to reference Embedded Resources in .net xmldoc comments?

I have a C# project that uses xml comments. I make chm files from them with Sandcastle via the Sandcastle Help File Builder. One of the member functions in this project makes use of an embedded resource. I want to reference it in the help file. It seems that sandcastle does not support this, but ...

2
голосов
1ответов
411 просмотров

How do I get Code Examples to show in the Help file using Sandcastle Help File Builder?

I'm using Sandcastle Help File Builder GUI and I can't seem to get code examples in my comments to appear in the help file output. I'm generating Help 1.x and MSDN-style HTML documentation. The examples look like the following in my code: /// <summary> /// Connects to the server ...

1
голосов
3ответов
391 просмотров

Is there a good quick start guide for generating API docs with Sandcastle?

I'm going to be generating API docs using Sandcastle - I couldn't find any guides on how to do this on there website. Does anyone have any quickstart guides they would recommend?

2
голосов
1ответов
849 просмотров

Sandcastle Topic Grouping

We're using Sandcastle to generate our source code documentation with our build process. This is working great for creating API level doc for classes, methods, properties, etc. Additionally, Sandcastle allows you to add summaries to your namespaces as well as "Conceptual Content". We're creati...

1
голосов
1ответов
390 просмотров

SandCastle and OutOfMemoryException

SandCastle is unable to process our class library because it crashes with an OutOfMemoryException exception during XSL transformation. What can we do about that, except for the obvious, buy more memory? The problem is that this is our developer machines with 3.3GB memory on a 32-bit OS so basica...

3
голосов
2ответов
225 просмотров

Можно ли настроить Sandcastle для создания страниц и ссылок, оптимизированных для SEO?

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

5
голосов
3ответов
1493 просмотров

Как создать ссылки типа MSDN на сайте документации Sandcastle?

Я создал веб-документацию своего проекта с помощью Sandcastle. На этом веб-сайте используются фреймы, поэтому, когда я нажимаю на сайты, мой URL-адрес в браузере не меняется. Я хотел бы, чтобы URL-адрес изменялся в браузере, когда я просматриваю документацию веб-сайта, созданную с помощью San...

1
голосов
1ответов
407 просмотров

Sandcastle - мертвые ссылки, "доступ запрещен" и другие беды

(Используя построитель GUI) Кто-нибудь знает, что этой штуке нужно от набора функций Html Help 2.x? Он продолжает выдавать ошибки «доступ запрещен» в любом нелокальном файле .chm, который он генерирует с указанием «ms-help: //hx/hxruntime/hxlink.htc». Та же ошибка для созданного веб-сайта....

16
голосов
7ответов
5551 просмотров

Замок из песка - все еще то, что нужно использовать? Или есть альтернативы?

Мне просто интересно - последний выпуск Sandcastle выпущен в мае 2008 г., и он до сих пор указан как Предварительная версия программного обеспечения / CTP, и она даже больше не лицензируется, как специально сказано в лицензионном соглашении: 2. СРОК. Срок действия этого соглашения - до 1...

4
голосов
1ответов
1070 просмотров

Упорядоченный список с помощью Sandcastle Help File Builder

Как сделать список в блоках xmldoc, отображаемых в виде упорядоченного списка, когда я создаю chm с помощью Sandcastle Helpfile Builder? Следующее не работает: /// <list type="numbered"> /// <item>Built in support for foobar</item> /// <item>Client gooblygoo...

8
голосов
1ответов
5253 просмотров

поместите пример кода в документацию, используя песочный замок

Я создаю файлы документации из xml-комментариев моего кода на C #, используя конструктор файлов справки Sandcastle. вы знаете, как включать примеры кода в файл справки, например, в стиле msdn?

0
голосов
1ответов
758 просмотров

SandCastle Help File Builder и MAML, как получить упорядоченный список с другим начальным индексом?

Я использую SandCastle Help File Builder 1.8.0.1 с его редактором содержимого MAML. Мне нужен упорядоченный список, начиная со значения, отличного от значения по умолчанию 1. 10. Some data 11. Other data Я даже пробовал следующее, но оно не работает, как из HTML для элемента OL: <...

11
голосов
6ответов
3021 просмотров

Инструмент создания справки с поддержкой MS Word и C # xmldoc

Мне нужен инструмент для создания справки / документации, который бы удовлетворял таким требованиям: он должен поддерживать комментарий xmldoc, созданный компилятором C #, или (что еще лучше) напрямую поддерживать замок из песка. он должен поддерживать импорт документов MS Word. он долже...

4
голосов
1ответов
1453 просмотров

Строитель файлов справки Sandcastle и VS 2008

как добавить проект построения файла справки Sandcastle (.shfbproj) в решение Visual Studio 2008?

1
голосов
1ответов
207 просмотров

Как я могу заставить Sandcastle хорошо играть с SVN?

Я пытаюсь добавить вывод компиляции Sandcastle в систему управления версиями, но Sandcastle имеет проблемы с попыткой вывода напрямую в структуру каталогов, управляемую Subversion. Итак, то, что я пытался сделать, это вывести в неконтролируемый каталог, а затем выполнить robocopy в структуру,...

13
голосов
3ответов
3775 просмотров

Могут ли классы реализации «наследовать» XML-комментарии от своих реализованных интерфейсов?

Любопытный вопрос. Я использую Microsoft Sandcastle для создания документации из комментариев XML в моем коде C #. Некоторые из моих классов реализуют интерфейсы, у которых уже есть закомментированные методы. Я бы предпочел не дублировать документацию как в методе интерфейса, так и в общедоступн...

0
голосов
1ответов
192 просмотров

Почему мои комментарии не включены в .chm, созданный SandCastle?

Мой .chm сгенерирован, а мои комментарии для классов, пространств имен, полей и членов - нет. Что я могу сделать, чтобы это исправить?

5
голосов
3ответов
2782 просмотров

Как мне документировать свой код C #?

Я создаю документацию для нашего C # API, содержащую: Общий обзор и описание текущего состояния в виде файла doc / pdf. API библиотеки классов в файле .chm с использованием Sandcastle. Вопросы: Следует ли объединить эти два файла в один файл .chm? Как лучше всего их объединить? Мне ...

0
голосов
1ответов
121 просмотров

Почему значение свойства работает, когда оно используется как значение атрибута, а не как значение элемента в msbuild?

Я пытаюсь создать документацию для своего приложения с помощью Sandcastle Help File Builder. Одно из требований - указать источник документации, например: <DocumentationSources> <DocumentationSource sourceFile="@(DocumentationSourceFiles)" xmlns="" /> </DocumentationSources...

1
голосов
1ответов
598 просмотров

Почему Sandcastle Help File Builder не сохраняет кэш Msdn в указанной папке?

Я пытаюсь создать документацию для своего приложения с помощью Sandcastle Help File Builder. Я добавил компонент кеширования Msdn в файл .shfbproj следующим образом: <ComponentConfigurations> <ComponentConfig id="Cached MSDN URL References" enabled="True" xmlns=""> <compo...

3
голосов
3ответов
2163 просмотров

Использование построителя файлов справки Sandcastle с MSBuild

Как я могу заставить Sandcastle Help File Builder создавать файлы справки из проектов, создаваемых с помощью MSBuild?

0
голосов
1ответов
177 просмотров

Что означает эта ошибка построителя файлов справки SandCastle?

Я пытаюсь создать файл справки с помощью построителя файлов справки SandCastle в msbuild, но получаю следующую ошибку: SandcastleBuilder.Utils.BuilderException: недопустимая или отсутствующая версия SchemaVersion Что это значит? И как мне исправить эту ошибку?

1
голосов
2ответов
1048 просмотров

CHM файл из файлов XSD

Можно ли создать файл CHM или справку в формате HTML (аналогично тем, которые созданы Sandcastle) из файла XSD? Текст в узлах xs:documentation содержит, ну, документацию. Пример фрагмента из одного из имеющихся у меня файлов XSD: <xs:element name="Request" type="RequestType"> &lt...

19
голосов
2ответов
2312 просмотров

Можем ли мы ускорить песочный замок?

Мы используем замок из песка (и SHFB ) для создания документации библиотеки классов из встроенных комментариев XML. Это отличный инструмент для поддержки полной и профессиональной справочной + обзорной документации, включая правильный код образцы . К сожалению, это тоже собака медленно. Э...

1
голосов
2ответов
313 просмотров

Моя сводная информация не будет отображаться в Sandcastle с использованием синтаксиса VB '' '

Я пытаюсь воспользоваться Sandcastle чтобы помочь в создании системной документации, но по какой-то странной причине ни один из моих данных <summary> не отображается в chm ... имел ли кто-нибудь успех с последней сборкой Sandcastle и VS2008 с использованием VB?

6
голосов
2ответов
2214 просмотров

Как связать / сгруппировать перегрузки в комментариях C # XML?

Есть ли способ в комментариях XML-документа для C # пометить две или более функций как перегрузки друг друга, чтобы они автоматически ссылались друг на друга? В идеале они также должны быть каким-то образом сгруппированы в документации, созданной замком из песка. Цель: часто мне нужно связать...

15
голосов
6ответов
2813 просмотров

Советы по комментированию XML для программирования на C #

Доброе утро, днем, вечером или ночью (в зависимости от вашего часового пояса) Это просто общий вопрос о комментариях XML в C #. Я никогда особо не комментировал свои программы, я всегда был более подробным средством именования переменных / свойств / методов и позволял коду говорить сам за себ...

1
голосов
1ответов
855 просмотров

Sandcastle -> Вывод в HTML -> Импорт в утилиту MOSS

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

9
голосов
2ответов
1589 просмотров

SandCastle Help Builder: функции поиска

Я очень доволен выводом SandCastle, но я также хотел бы включить некоторые функции поиска в вывод HTML, возможно ли это?