powered by simpleCommunicator - 2.0.59     © 2025 Programmizd 02
Целевая тема:
Создать новую тему:
Автор:
Закрыть
Цитировать
Форумы / Delphi [игнор отключен] [закрыт для гостей] / XML комментарий к юниту
25 сообщений из 33, страница 1 из 2
XML комментарий к юниту
    #38134029
Фотография Feg16
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Как правильно сделать комментарий, чтобы он отобразился в этом чертовом урезанном и беспантовом Code Insight? =)
Код: pascal
1.
2.
3.
4.
///<summary>
///  Базовый класс создания модальных nagscreen
///</summary>
unit ufmBobBase;
...
Рейтинг: 0 / 0
XML комментарий к юниту
    #38134039
Фотография Feg16
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
И заодно подскажите эксперт хороший, чтобы комментарий можно было в удобном окошке вводить, для домохозяек, а он сам потом сформировал нужный код :)
...
Рейтинг: 0 / 0
XML комментарий к юниту
    #38134254
Arioch
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Feg16И заодно подскажите эксперт хороший, чтобы комментарий можно было в удобном окошке вводить

Вообще-то это не CodeInsight, a Doc Insight
Соответсвенно, есди очешь окошка и поддержки разных тегов - надо покупать полную версию - http://www.devjetsoftware.com/products/documentation-insight/

Но я попробовал полгода назад триалку, посмотрел на глдюки - и вернул себе бeсплатный Express
...
Рейтинг: 0 / 0
XML комментарий к юниту
    #38134279
Фотография Feg16
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
А... полную версию, спасиб.AriochНо я попробовал полгода назад триалку, посмотрел на глдюкиВот и пропал весь запал задокументировать проект :(
...
Рейтинг: 0 / 0
XML комментарий к юниту
    #38134285
Arioch
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
я тут скачал helpndoc-setup
но пока не было времени

триалка бесплатная хоть на всю жизнь
и в рекламе все просто отлично

но... оно взеде отлично :-)
...
Рейтинг: 0 / 0
XML комментарий к юниту
    #38134286
Arioch
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Feg16,

если хочешь комментами - можешь попробовать ожэивить такие проекты как

DiPasDoc
pasdoc
DelphiCodeToDoc
HTMLDOC
pas2dox + doxygen

Потом расскажешь, вдруг там правда все просто и все работает :-)
...
Рейтинг: 0 / 0
XML комментарий к юниту
    #38134289
Фотография Feg16
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
AriochПотом расскажешь, вдруг там правда все просто и все работает :-)Спасиб! Утром попробую подобрать что попроще и поработоспособнее. А то стандартными средствами на _интерфейсную_ часть в 3 юнита - почти сутки ушли
...
Рейтинг: 0 / 0
XML комментарий к юниту
    #38134292
Фотография Feg16
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Мне в принципе формировать выходной документ не нужно. Мне нужно чтобы я через полгода ткнув на класс прочел его описание, все зависимости / параметры / и т.п. и сразу приступил к работе, а не копался как же он подляк такой работает так хитро :)
...
Рейтинг: 0 / 0
XML комментарий к юниту
    #38134323
GunSmoker
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
1. Бесплатный Documentation Insight Express входит в состав Delphi последних версий (XE2+).
2. Референс-доки по XML комментам можно взять на сайте того же Documentation Insight .
3. Вместо Documentation Insight можно использовать Live Templates .
4. XML комментарии удобно заворачивать в $REGION .
5. Чтобы XML комментарий в модули подхватился Help Insight, модуль должен входить в состав проекта .
6. Самая проблема - гиперссылки на идентификаторы. В Delphi с этим неразбериха. Родной Help Insight использует один формат, родной же DocGen - другой. Формата два: "Unit.Class.Routine" и "Unit|Class.Routine". Рекомендую использовать второй.
7. XML комментарии могут быть преобразованы в документацию. Это можно сделать:
а). Встроенным средством . Честно - говно. Сложно заставить работать и, что главное, крайне сложно кастомизировать. Но - бесплатно и стандартное.
б). Doc-O-Matic. Результат - посредственный. Работает, кастомизировать можно, но в целом - "не вылизано".
в). DocGen-ом Documentation Insight 2 Enterprise . Вывод - HTML, CHM, MS Help 2, Help&Manual. Результат - отличный .

Ну и в целом глянуть .

P.S. Лично меня не устроили существующие решения генерации документации по исходному коду и я написал свой генератор на базе парсера касталии. Результат вывода можно посмотреть, к примеру, тут . Сырцы генератора я отдал автору Documentation Insight по его просьбе. Делал ли он свой DocGen на базе моего или писал с нуля - не в курсе.
...
Рейтинг: 0 / 0
XML комментарий к юниту
    #38134329
GunSmoker
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Ну и терминология:

Help Insight - встроенная хрюля в IDE, которая показывает всплывающие подсказки при наведении мышью на идентификаторы. Подсказки создаются по XML-комментариям, если они есть, или автогенерируются пустые. Подсказка оформляется в соответствии с XML/XSL шаблоном. Шаблон можно заменить на свой.

Documentation Insight - сторонний IDE-эксперт к IDE, который был включён в стандартную поставку IDE, начиная с XE2. Показывает WYSIWYG-окно редактирования документации (XML-комментов) и заменяет XSL шаблон Help Insight на расширенный. Старшие версии имеют дополнительные пряники.

DocInsight - если только как сокращение Documentation Insight.
...
Рейтинг: 0 / 0
XML комментарий к юниту
    #38134330
GunSmoker
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Code Insight - встроенная в IDE хрюля, которая помогает писать код. Состоит из Code Completion (Ctrl + Пробел, высвечивает список после точки), Code Parameters (Ctrl + Shift + пробел, показывает подсказку по аргументам) и Class Completion (Ctrl + Shift + C, завершает объявление класса).
...
Рейтинг: 0 / 0
XML комментарий к юниту
    #38134333
GunSmoker
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Соответственно, чтобы ответить на исходный вопрос, надо:
1. Определится с терминологией. Code Insight не имеет отношения к комментам и документации. Он не может быть урезанным. Подсказки показывает Help Insight, и он - всегда встроенный. И поэтому тоже не может быть урезанным.
2. Определится с тем, какая стоит версия IDE, Documentation Insight (если есть) и какой установлен шаблон для Help Insight.
3. Проверить, является ли модуль с комментами частью проекта или же просто перечислен в uses.
...
Рейтинг: 0 / 0
XML комментарий к юниту
    #38134335
GunSmoker
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Arioch, а чё за глюки? У меня ынтырпрайз стоит, вроде весьма стабилен. Про глюки лучше разработчику написать, поправит.
...
Рейтинг: 0 / 0
XML комментарий к юниту
    #38134348
Arioch
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
GunSmoker,

писал тогда, он говорил "да я наверное выпущу попозже обновленный экспресс" ну и заглохло.

может быть с aqtime пересекался - он вроде много где глюки наводил
...
Рейтинг: 0 / 0
XML комментарий к юниту
    #38134354
Arioch
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
GunSmoker4. XML комментарии удобно заворачивать в $REGION .


Зачем ? они же сами себе регионы ?
...
Рейтинг: 0 / 0
XML комментарий к юниту
    #38134356
Arioch
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
GunSmoker Сырцы генератора я отдал автору Documentation Insight по его просьбе.

мог бюы и в сеть выложить, ты ж ему ,надеюсь, не эксклюзивно отдал ? :-)
...
Рейтинг: 0 / 0
XML комментарий к юниту
    #38134384
GunSmoker
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
авторможет быть с aqtime пересекался

Тащемта этот AQTime спокойно крешит даже чистую IDE, что уж говорить про нагруженную. Или может и не он крешит, а крешится IDE, а он только лезет отчёт отправлять. Но пинать все будут его...

авторЗачем ? они же сами себе регионы ?

Сами по себе они не регионы.

Код: pascal
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
///	<summary>
///	  Base unit for dialogs.
///	</summary>
///	<remarks>
///	  <para>
///	    This unit contains basic abstract class for implementing error dialogs in EurekaLog. It also registers build-in
///	    classes like NULL dialog and MessageBox dialog.
///	  </para>
///	  <para>
///	    Non-trivial error dialogs are implemented in other units (see below), which refers to this unit (EDialog) and 
///	    implement one or more child sub-classes.
///	  </para>
///	</remarks>



Это - не регион.

Чтобы это стало регионом (и чтобы его можно было сворачивать), надо добавить $REGION:

Код: pascal
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
{$REGION 'Documentation'}
///	<summary>
///	  Base unit for dialogs.
///	</summary>
///	<remarks>
///	  <para>
///	    This unit contains basic abstract class for implementing error dialogs in EurekaLog. It also registers build-in
///	    classes like NULL dialog and MessageBox dialog.
///	  </para>
///	  <para>
///	    Non-trivial error dialogs are implemented in other units (see below), which refers to this unit (EDialog) and 
///	    implement one or more child sub-classes.
///	  </para>
///	</remarks>
{$ENDREGION}



Или даже так:

Код: pascal
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
{$IFDEF SUPPORTS_REGION}{$REGION 'Documentation'}{$ENDIF}
///	<summary>
///	  Base unit for dialogs.
///	</summary>
///	<remarks>
///	  <para>
///	    This unit contains basic abstract class for implementing error dialogs in EurekaLog. It also registers build-in
///	    classes like NULL dialog and MessageBox dialog.
///	  </para>
///	  <para>
///	    Non-trivial error dialogs are implemented in other units (see below), which refers to this unit (EDialog) and 
///	    implement one or more child sub-classes.
///	  </para>
///	</remarks>
{$IFDEF SUPPORTS_REGION}{$ENDREGION}{$ENDIF}



Само собой, SUPPORTS_REGION ещё надо определить в опция проекта или .inc файле.

Documentation Insight автоматически добавляет регионы к XML комментам, это да. Но это - не "сами себе".

автормог бюы и в сеть выложить, ты ж ему ,надеюсь, не эксклюзивно отдал ? :-)

Не эксклюзивно, но:
1. Там страшный код, который писался два дня "лишь бы работало".
2. Он заточен под EurekaLog и там куча нестандартных правил для ссылок (к примеру, ссылки на внешний CHM).
3. Пока никто им не интересовался.

В свете наличия готового DocGen в Documentation Insight, который вылизан и заточен под Delphi, смысла в моей поделке для широкой публики я не вижу. Я бы и переключился на DocGen от Documentation Insight, но меня останавливает только несовместимость. У нас другой стиль справки и вот эти самые нестандартные правила оформления ссылок.
...
Рейтинг: 0 / 0
XML комментарий к юниту
    #38134455
Arioch
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
GunSmokerСами по себе они не регионы.

Я несомненно что-то делаю не так, но...
https://docs.google.com/folder/d/0B5BzBHTOWJouTDZrVGgweEJnV3M/edit?usp=sharing
...
Рейтинг: 0 / 0
XML комментарий к юниту
    #38134483
GunSmoker
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Это только в XE2+. В XE и ниже XML-комменты - не регионы.
...
Рейтинг: 0 / 0
XML комментарий к юниту
    #38134488
Arioch
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
GunSmoker,

но мне показалось, что автор про хе2+ и говорит, ведь раньше на борту Doc Insight Express не было...
...
Рейтинг: 0 / 0
XML комментарий к юниту
    #38134530
GunSmoker
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Без понятия, что у автора. А DI поддерживает D7+.
...
Рейтинг: 0 / 0
XML комментарий к юниту
    #38134559
Arioch
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
GunSmoker,

но "из каропки" идет только с хе2. А автор явно не знал, что него там такое стоит.
Если бы это была Д7 - его первая враза была бы сильно другой :-)
...
Рейтинг: 0 / 0
Период между сообщениями больше года.
XML комментарий к юниту
    #40073265
Benten
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Гость
Добрый день всем форумчанам!
Хотел бы актуализировать вопрос, поднятый много лет назад.
Умышленно не стал создавать новую тему, чтобы видеть историю
Спасибо многоуважаемому @GunSmoker за подробное разъяснение про Document Insight
GunSmoker
1. Бесплатный Documentation Insight Express входит в состав Delphi последних версий (XE2+).
....
Ну и в целом глянуть .
У меня есть несколько вопросов, ответы на которые возможно заинтересуют многих:
1. Что-то я не нашел бесплатного Documentation Insight Express в составе Delphi Sydney 10.4.2, плохо искал или убрали?
2. Насколько актуален Document Insight для последнего Embarcadero Delphi Sydney 10.4.2, корректно ли последний DocInsight работает в Delphi 10.4.2?
3. Есть на сегодня другие, не менее интересные решения для редактирования и генерации документации из XML-комментов?
4. Сталкивался ли кто-нибудь с тем, что в 10.4.2. сломали отображение встроенной подсказки Help Insight на базе xml-комментов?
В 10.3.3 еще работает, проверял.
...
Рейтинг: 0 / 0
XML комментарий к юниту
    #40073356
Benten
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Гость
Уже пробую Documentation Insigt Ultimate 3.10.12.16 в Delphi Sydney 10.4.2.
Пока все работает. Посмотрю, что дальше ...
Если понравится, буду покупать :-))
...
Рейтинг: 0 / 0
XML комментарий к юниту
    #40073411
asutp2
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Benten,

В 10.4.2 завертывание в {$REGION 'Document'} по большому счету уже и не нужно, т.к. IDE позволяет нормально схлопывать само xml-описание, по аналогии с region
...
Рейтинг: 0 / 0
25 сообщений из 33, страница 1 из 2
Форумы / Delphi [игнор отключен] [закрыт для гостей] / XML комментарий к юниту
Найденые пользователи ...
Разблокировать пользователей ...
Читали форум (0):
Пользователи онлайн (0):
x
x
Закрыть


Просмотр
0 / 0
Close
Debug Console [Select Text]