Delphi и XML документация кода.
Пользователи, просматривающие топик: none
|
Зашли как: Guest
|
Имя  |
| Сообщение |
<< Старые топики Новые топики >> |
|
|
Delphi и XML документация кода. - 2010-03-27 21:05:15.310000
|
|
|
Genco
Сообщений: 1662
Оценки: 90
Присоединился: 2007-12-16 23:11:22.003333
|
Сделал для себя небольшое и не очень приятное открытие - код порой приходится документировать. Принес людям поделку, с исходниками,в них комментарии,отдельно pdf-ка с описанием. А мне и говорят - где же,дескать,прикрепленный XML-файл? Я так понял *объясняли* что каким то специальным хитрым средством из Delphi *язык именно этот,потому и решение нужно для него* создается такой файлик,в котором отражается всякая инфа,комментарии,изменения,причем он автоматически соответствует последней версии исходника, привязан как-то…Вот большего я не добился,что это и как гуглить не совсем понимаю. Просветите пожалуйста,кто знает/слышал/пользовался. Достаточно даже просто сказать как это называется))
|
|
|
|
|
RE: Delphi и XML документация кода. - 2010-03-27 22:26:50.376666
|
|
|
rgo
Сообщений: 7170
Оценки: 281
Присоединился: 2004-09-25 05:14:25
|
Существуют разные решения. Идея – это специального вида комментарии, и компилятор, который обрабатывает файлы проекта, выдирает оттуда комментарии, и оформляет их в виде xml/html/texinfo или какого-то ещё формата документации. Их много всяких – всякие там javadoc, autodoc, gtkdoc, но они не для дельфи.
Лёгкое гугленье вывело меня сюда: http://delphi.about.com/od/fullcodeprojects/a/delphicodetodoc.htm
Я не знаю единственное ли это решение для delphi, а если не единственное, то популярнейшее ли, лучшее ли, или ещё какое ли. Но я думаю двигаясь оттуда по ссылкам и ключевым словам можно всё это выяснить.
|
|
|
|
|
RE: Delphi и XML документация кода. - 2010-03-27 22:39:50.886666
|
|
|
Genco
Сообщений: 1662
Оценки: 90
Присоединился: 2007-12-16 23:11:22.003333
|
Хохо,пасиба!! Этот вроде вполне хорош,а мне любой подойдет, да и действительно ещё покопаюсь. А я уж думал что-то совсем хитрое там.
Блин…могли бы они и в коде читать что написано,невелик напряг.
|
|
|
|
|
RE: Delphi и XML документация кода. - 2010-03-27 23:14:27.200000
|
|
|
rgo
Сообщений: 7170
Оценки: 281
Присоединился: 2004-09-25 05:14:25
|
quote:
ORIGINAL: Genco
Блин…могли бы они и в коде читать что написано,невелик напряг.
Нну такого рода вещи бывают и посложнее – они бывает парсят все объявления классов, и втыкают в документацию картинки с иерархией. Они создают индексы – типов, функций, глобальных переменных. И в случаях больших проектов это бывает удобно.
|
|
|
|
|
RE: Delphi и XML документация кода. - 2010-03-28 01:06:21.760000
|
|
|
Genco
Сообщений: 1662
Оценки: 90
Присоединился: 2007-12-16 23:11:22.003333
|
Просто привык,что нечто подобное встроено в IDE и само всё покажет. Но ворчу я действительно зря,им-то так лучше как раз)).
|
|
|
|
|
|
