Этот баннер — требование Роскомнадзора для исполнения 152 ФЗ.
«На сайте осуществляется обработка файлов cookie, необходимых для работы сайта, а также для анализа использования сайта и улучшения предоставляемых сервисов с использованием метрической программы Яндекс.Метрика. Продолжая использовать сайт, вы даёте согласие с использованием данных технологий».
Политика конфиденциальности
|
|
|
XML комментарий к юниту
|
|||
|---|---|---|---|
|
#18+
Как правильно сделать комментарий, чтобы он отобразился в этом чертовом урезанном и беспантовом Code Insight? =) Код: pascal 1. 2. 3. 4. ... |
|||
|
:
Нравится:
Не нравится:
|
|||
| 01.02.2013, 16:36 |
|
||
|
XML комментарий к юниту
|
|||
|---|---|---|---|
|
#18+
И заодно подскажите эксперт хороший, чтобы комментарий можно было в удобном окошке вводить, для домохозяек, а он сам потом сформировал нужный код :) ... |
|||
|
:
Нравится:
Не нравится:
|
|||
| 01.02.2013, 16:40 |
|
||
|
XML комментарий к юниту
|
|||
|---|---|---|---|
|
#18+
Feg16И заодно подскажите эксперт хороший, чтобы комментарий можно было в удобном окошке вводить Вообще-то это не CodeInsight, a Doc Insight Соответсвенно, есди очешь окошка и поддержки разных тегов - надо покупать полную версию - http://www.devjetsoftware.com/products/documentation-insight/ Но я попробовал полгода назад триалку, посмотрел на глдюки - и вернул себе бeсплатный Express ... |
|||
|
:
Нравится:
Не нравится:
|
|||
| 01.02.2013, 18:57 |
|
||
|
XML комментарий к юниту
|
|||
|---|---|---|---|
|
#18+
А... полную версию, спасиб.AriochНо я попробовал полгода назад триалку, посмотрел на глдюкиВот и пропал весь запал задокументировать проект :( ... |
|||
|
:
Нравится:
Не нравится:
|
|||
| 01.02.2013, 19:18 |
|
||
|
XML комментарий к юниту
|
|||
|---|---|---|---|
|
#18+
я тут скачал helpndoc-setup но пока не было времени триалка бесплатная хоть на всю жизнь и в рекламе все просто отлично но... оно взеде отлично :-) ... |
|||
|
:
Нравится:
Не нравится:
|
|||
| 01.02.2013, 19:23 |
|
||
|
XML комментарий к юниту
|
|||
|---|---|---|---|
|
#18+
Feg16, если хочешь комментами - можешь попробовать ожэивить такие проекты как DiPasDoc pasdoc DelphiCodeToDoc HTMLDOC pas2dox + doxygen Потом расскажешь, вдруг там правда все просто и все работает :-) ... |
|||
|
:
Нравится:
Не нравится:
|
|||
| 01.02.2013, 19:25 |
|
||
|
XML комментарий к юниту
|
|||
|---|---|---|---|
|
#18+
AriochПотом расскажешь, вдруг там правда все просто и все работает :-)Спасиб! Утром попробую подобрать что попроще и поработоспособнее. А то стандартными средствами на _интерфейсную_ часть в 3 юнита - почти сутки ушли ... |
|||
|
:
Нравится:
Не нравится:
|
|||
| 01.02.2013, 19:27 |
|
||
|
XML комментарий к юниту
|
|||
|---|---|---|---|
|
#18+
Мне в принципе формировать выходной документ не нужно. Мне нужно чтобы я через полгода ткнув на класс прочел его описание, все зависимости / параметры / и т.п. и сразу приступил к работе, а не копался как же он подляк такой работает так хитро :) ... |
|||
|
:
Нравится:
Не нравится:
|
|||
| 01.02.2013, 19:30 |
|
||
|
XML комментарий к юниту
|
|||
|---|---|---|---|
|
#18+
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 на базе моего или писал с нуля - не в курсе. ... |
|||
|
:
Нравится:
Не нравится:
|
|||
| 01.02.2013, 20:09 |
|
||
|
XML комментарий к юниту
|
|||
|---|---|---|---|
|
#18+
Ну и терминология: Help Insight - встроенная хрюля в IDE, которая показывает всплывающие подсказки при наведении мышью на идентификаторы. Подсказки создаются по XML-комментариям, если они есть, или автогенерируются пустые. Подсказка оформляется в соответствии с XML/XSL шаблоном. Шаблон можно заменить на свой. Documentation Insight - сторонний IDE-эксперт к IDE, который был включён в стандартную поставку IDE, начиная с XE2. Показывает WYSIWYG-окно редактирования документации (XML-комментов) и заменяет XSL шаблон Help Insight на расширенный. Старшие версии имеют дополнительные пряники. DocInsight - если только как сокращение Documentation Insight. ... |
|||
|
:
Нравится:
Не нравится:
|
|||
| 01.02.2013, 20:19 |
|
||
|
XML комментарий к юниту
|
|||
|---|---|---|---|
|
#18+
Code Insight - встроенная в IDE хрюля, которая помогает писать код. Состоит из Code Completion (Ctrl + Пробел, высвечивает список после точки), Code Parameters (Ctrl + Shift + пробел, показывает подсказку по аргументам) и Class Completion (Ctrl + Shift + C, завершает объявление класса). ... |
|||
|
:
Нравится:
Не нравится:
|
|||
| 01.02.2013, 20:22 |
|
||
|
XML комментарий к юниту
|
|||
|---|---|---|---|
|
#18+
Соответственно, чтобы ответить на исходный вопрос, надо: 1. Определится с терминологией. Code Insight не имеет отношения к комментам и документации. Он не может быть урезанным. Подсказки показывает Help Insight, и он - всегда встроенный. И поэтому тоже не может быть урезанным. 2. Определится с тем, какая стоит версия IDE, Documentation Insight (если есть) и какой установлен шаблон для Help Insight. 3. Проверить, является ли модуль с комментами частью проекта или же просто перечислен в uses. ... |
|||
|
:
Нравится:
Не нравится:
|
|||
| 01.02.2013, 20:26 |
|
||
|
XML комментарий к юниту
|
|||
|---|---|---|---|
|
#18+
Arioch, а чё за глюки? У меня ынтырпрайз стоит, вроде весьма стабилен. Про глюки лучше разработчику написать, поправит. ... |
|||
|
:
Нравится:
Не нравится:
|
|||
| 01.02.2013, 20:29 |
|
||
|
XML комментарий к юниту
|
|||
|---|---|---|---|
|
#18+
GunSmoker, писал тогда, он говорил "да я наверное выпущу попозже обновленный экспресс" ну и заглохло. может быть с aqtime пересекался - он вроде много где глюки наводил ... |
|||
|
:
Нравится:
Не нравится:
|
|||
| 01.02.2013, 20:53 |
|
||
|
XML комментарий к юниту
|
|||
|---|---|---|---|
|
#18+
GunSmoker Сырцы генератора я отдал автору Documentation Insight по его просьбе. мог бюы и в сеть выложить, ты ж ему ,надеюсь, не эксклюзивно отдал ? :-) ... |
|||
|
:
Нравится:
Не нравится:
|
|||
| 01.02.2013, 21:02 |
|
||
|
XML комментарий к юниту
|
|||
|---|---|---|---|
|
#18+
авторможет быть с aqtime пересекался Тащемта этот AQTime спокойно крешит даже чистую IDE, что уж говорить про нагруженную. Или может и не он крешит, а крешится IDE, а он только лезет отчёт отправлять. Но пинать все будут его... авторЗачем ? они же сами себе регионы ? Сами по себе они не регионы. Код: pascal 1. 2. 3. 4. 5. 6. 7. 8. 9. 10. 11. 12. 13. Это - не регион. Чтобы это стало регионом (и чтобы его можно было сворачивать), надо добавить $REGION: Код: pascal 1. 2. 3. 4. 5. 6. 7. 8. 9. 10. 11. 12. 13. 14. 15. Или даже так: Код: pascal 1. 2. 3. 4. 5. 6. 7. 8. 9. 10. 11. 12. 13. 14. 15. Само собой, SUPPORTS_REGION ещё надо определить в опция проекта или .inc файле. Documentation Insight автоматически добавляет регионы к XML комментам, это да. Но это - не "сами себе". автормог бюы и в сеть выложить, ты ж ему ,надеюсь, не эксклюзивно отдал ? :-) Не эксклюзивно, но: 1. Там страшный код, который писался два дня "лишь бы работало". 2. Он заточен под EurekaLog и там куча нестандартных правил для ссылок (к примеру, ссылки на внешний CHM). 3. Пока никто им не интересовался. В свете наличия готового DocGen в Documentation Insight, который вылизан и заточен под Delphi, смысла в моей поделке для широкой публики я не вижу. Я бы и переключился на DocGen от Documentation Insight, но меня останавливает только несовместимость. У нас другой стиль справки и вот эти самые нестандартные правила оформления ссылок. ... |
|||
|
:
Нравится:
Не нравится:
|
|||
| 01.02.2013, 21:29 |
|
||
|
XML комментарий к юниту
|
|||
|---|---|---|---|
|
#18+
GunSmokerСами по себе они не регионы. Я несомненно что-то делаю не так, но... https://docs.google.com/folder/d/0B5BzBHTOWJouTDZrVGgweEJnV3M/edit?usp=sharing ... |
|||
|
:
Нравится:
Не нравится:
|
|||
| 01.02.2013, 22:42 |
|
||
|
XML комментарий к юниту
|
|||
|---|---|---|---|
|
#18+
Это только в XE2+. В XE и ниже XML-комменты - не регионы. ... |
|||
|
:
Нравится:
Не нравится:
|
|||
| 01.02.2013, 23:07 |
|
||
|
XML комментарий к юниту
|
|||
|---|---|---|---|
|
#18+
GunSmoker, но мне показалось, что автор про хе2+ и говорит, ведь раньше на борту Doc Insight Express не было... ... |
|||
|
:
Нравится:
Не нравится:
|
|||
| 01.02.2013, 23:13 |
|
||
|
XML комментарий к юниту
|
|||
|---|---|---|---|
|
#18+
Без понятия, что у автора. А DI поддерживает D7+. ... |
|||
|
:
Нравится:
Не нравится:
|
|||
| 02.02.2013, 00:34 |
|
||
|
XML комментарий к юниту
|
|||
|---|---|---|---|
|
#18+
GunSmoker, но "из каропки" идет только с хе2. А автор явно не знал, что него там такое стоит. Если бы это была Д7 - его первая враза была бы сильно другой :-) ... |
|||
|
:
Нравится:
Не нравится:
|
|||
| 02.02.2013, 01:42 |
|
||
|
XML комментарий к юниту
|
|||
|---|---|---|---|
|
#18+
Добрый день всем форумчанам! Хотел бы актуализировать вопрос, поднятый много лет назад. Умышленно не стал создавать новую тему, чтобы видеть историю Спасибо многоуважаемому @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 еще работает, проверял. ... |
|||
|
:
Нравится:
Не нравится:
|
|||
| 26.05.2021, 18:38 |
|
||
|
XML комментарий к юниту
|
|||
|---|---|---|---|
|
#18+
Уже пробую Documentation Insigt Ultimate 3.10.12.16 в Delphi Sydney 10.4.2. Пока все работает. Посмотрю, что дальше ... Если понравится, буду покупать :-)) ... |
|||
|
:
Нравится:
Не нравится:
|
|||
| 26.05.2021, 23:50 |
|
||
|
|

start [/forum/topic.php?fid=58&msg=38134356&tid=2037293]: |
0ms |
get settings: |
10ms |
get forum list: |
14ms |
check forum access: |
3ms |
check topic access: |
3ms |
track hit: |
162ms |
get topic data: |
9ms |
get forum data: |
2ms |
get page messages: |
50ms |
get tp. blocked users: |
1ms |
| others: | 285ms |
| total: | 539ms |

| 0 / 0 |
