Справочник функций

Ваш аккаунт

Войти через: 
Забыли пароль?
Регистрация
Информацию о новых материалах можно получать и без регистрации:

Почтовая рассылка

Подписчиков: -1
Последний выпуск: 19.06.2015

xml documentation - как?

3.0K
24 февраля 2007 года
Oxaid
63 / / 02.04.2006
Пишу свой компонент. Использую xml документирование. Настроил в студии, чтобы она мне xml генерила. Вопрос в том как сделать так, чтобы при использовании этого компонента в другом проекте вылазили эти подсказки или чтобы как-то через help можно было бы посмотреть, что метод делает?
242
25 февраля 2007 года
Оlga
2.2K / / 04.02.2006
а коментарии c xml-тегами не помагают?
3.0K
25 февраля 2007 года
Oxaid
63 / / 02.04.2006
В этом вся проблема, что не помогают. И коментарии пишу и xml получаю. А когда добавляю свой компонент в другой проект ничего не появляется. Может кто-нить напишет последовательность действий, может я что упустил.
3.0K
25 февраля 2007 года
Oxaid
63 / / 02.04.2006
Частично проблему решил - подсказки при написании кода появляются. Мне необходимо сделать help по компоненту, чтобы я мого просмотреть его как файлы справки через F1. И еще, как сделать чтобы в окне свойств при выборе свойства внизу отображалось его описание? Короче как сделать полноценный документированный компонент.
273
26 февраля 2007 года
3A3-968M
1.2K / / 22.12.2005
Чтобы подсказки вылазили в коде к твоему классу, нужно вместе со своей сборкой распространять и соответствующий XML файл справки. А на счёт создания из XML справки самый простой способ - сгенерировать HTML файл из XML файла. Поищи по форуму, я выкладывал программку для преобразования XML файла документации в HTML. Если не найдёшь, так скину.
3.0K
26 февраля 2007 года
Oxaid
63 / / 02.04.2006
Я нашел на форуме вопрос Track-а, но ему ты похоже прогу на мыло скидывал. Если есть ссылка где можно скачать - давай, если нет, то - [email]Oxaid@mail.ru[/email]
273
01 марта 2007 года
3A3-968M
1.2K / / 22.12.2005
Советую тебе преобразовывать xml в html динамически, что бы можно было кидать обновленные xml файлы хэлпа и не думать о конвертации. Вот пример код, который преобразует XML в HTML:
 
Код:
[SIZE=2][COLOR=#008080][FONT=Courier New]String[/FONT][/COLOR][/SIZE][FONT=Courier New][SIZE=2] xmlfile = [/SIZE][SIZE=2][COLOR=#800000]"Input.xml"[/COLOR][/SIZE][SIZE=2]; [/SIZE][SIZE=2][COLOR=#008000]// имя xml файла
[/COLOR][/SIZE][/FONT][SIZE=2][/SIZE][FONT=Courier New][SIZE=2][COLOR=#008080]String[/COLOR][/SIZE][SIZE=2] xslfile = [/SIZE][SIZE=2][COLOR=#800000]"cs.xsl"[/COLOR][/SIZE][SIZE=2]; [/SIZE][SIZE=2][COLOR=#008000]// имя xsl файла
[/COLOR][/SIZE][/FONT][SIZE=2][/SIZE][FONT=Courier New][SIZE=2][COLOR=#008080]XslTransform[/COLOR][/SIZE][SIZE=2] xslt = [/SIZE][SIZE=2][COLOR=#0000ff]new [/COLOR][/SIZE][SIZE=2][COLOR=#008080]XslTransform[/COLOR][/SIZE][/FONT][SIZE=2][FONT=Courier New]();[/FONT]
[FONT=Courier New]xslt.Load(xslfile); [/FONT][/SIZE][SIZE=2][COLOR=#008000][FONT=Courier New]// Загрузить xsl файл [/FONT]
[/COLOR][/SIZE][SIZE=2][FONT=Courier New]xslt.Transform([/FONT][/SIZE][FONT=Courier New][SIZE=2][COLOR=#800000]"Input.xml"[/COLOR][/SIZE][SIZE=2], [/SIZE][SIZE=2][COLOR=#800000]"Output.html"[/COLOR][/SIZE][/FONT][SIZE=2][FONT=Courier New]);[/FONT]
[/SIZE]

Т.е. происходит преобразование XML с применением внешней таблицы стилей. Где Input.xml - твой исходный XML файл с документацией, cs.xsl - таблица стилей, Output.html - выходной HTML файл. Таблицу стилей возмёшь в аттаче.
3.0K
03 марта 2007 года
Oxaid
63 / / 02.04.2006
Все бы хорошо, только вот получается что-то уж очень отадленно напоминающее MSDN.

html содержить что-то типа таких блоков:

*****************************************************
Code element: P:Rndlib.Properties.Resources.Culture

Summary
Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class.
******************************************************

C одной стороны что-то проглядывается, но совсем не так как хотелось бы.
Да и как бы сделать чтобы как MSDN открывалось через F1? И чтобы описание отдельных методов на отдельных html - ах было?
Может лучше всю прогу скинь или ссылку дай.
273
06 марта 2007 года
3A3-968M
1.2K / / 22.12.2005
Та прога работает так же. А научить Document Explorer отображать нужный контент - это уж извиняйте, никак. В приложении отображать нужные данные при нажатии F1 - это обработка события HelpRequested. Если не устраивает оформление HTML кода, полученного указанным мною путём, то у тебя есть мой файл таблицы стилей, подправь его, добавив туда средства для "разукрашивания" текста (HTML-тэги font, атрибуты style и т.д..)
Реклама на сайте | Обмен ссылками | Ссылки | Экспорт (RSS) | Контакты
Добавить статью | Добавить исходник | Добавить хостинг-провайдера | Добавить сайт в каталог