Можно. Для этого потребуется:
- Установить ант
- Настроить ант
- Запустить ант
- Написать комментарии в коде
1. Что же такое ант?
Apache Ant (англ.ant — муравей и акроним — «Another Neat Tool») — утилита для автоматизации процесса сборки программного продукта. Является платформонезависимым аналогом утилиты make (в качестве «Makefile» применяется «build.xml»).
(с) Википедия
Скачать эту замечательную утилиту можно по адресу: http://ant.apache.org/bindownload.cgi.
К данной замечательной утилите потребуется два плагина. Первый это плагин http://ant-doxygen.blogspot.ru/, а второй — это плагин к анту, написаный мной и прекрепленный к данной статье.
Второй плагин ни делает ничего, кроме выгрузки модулей 1С и преобразования их в код на подобии java.
2. Как настроить ант?
К этой статье приложен файл: «build.xml», в нем надо заменить пути к файлам и значения, на ваши. Скачать и подправить файл настройки doxigen (так же приложен к данной статье).
3. Как запустить ант?
Запустить cmd.exe или PowerShell и перейти в каталог с файлом build.xml и запустить ant all.
4. Комментарии
Комментарии нужно оформить в стиле javadoc или doxigen, но есть маленькая специфика. Что бы ваша документация ложилаь по простанствам имен(пакетам) я добавил от себя следующие правила:
Если модуль начинается с комментария:
// $subsystem=[имя]
// [Какое-то описание]
// $
То это этот модуль попадет в [имя].ОбщийМодуль.ИмяОбщегоМодуля.
Если же такого комментария не будет, то он попадет в ОбщийМодуль.ИмяОбщегоМодуля.
5. Итог
Вуаля документация у вас готова.
P.S. Прошу прощенья, если описание не внятно. Но описание я пишу почти через год после написания программы. Может чего и забыл.
Related Posts
Получение логина и пароля техподдержки 1С из базы
Класс для вывода отчета в Excel
Счет-фактура для УПП
Библиотека классов для создания внешней компоненты 1С на C#- Акт об оказании услуг (со скидками) — внешняя печатная форма для Управление торговлей 11.1.10.86
Прайс-лист с артикулом в отдельной колонке
Ничего не понял вообще. Понятно только что документация, но какая и для чего и как настроить что бы заработало и что должно получится. Все равно что посадить пользователя, который работал на 7.7., перед УПП и сказать: Вот…
(1) script,
Ну, вот такая как на скриншете. Для того кому надо.
Ну если вкурсе про ант, и doxigen — то подправить конфиги, а если нет — читать документаци по ант и доксигену.
А что бы вы хотели?
В точку. Современные системы проектировани по сравнению с конфигуратором, как самолет и самокат. Токо что слова одинаковые «само».
Ну это юмор. Надеюсь я им не обидел, а заставил улыбнутся.
А серьезно можно по порядку? Что непонятно? Где найти документацию по установке? Или как форматировать комментарии в доксиген стиле? Я попробую ответить на конкретные вопросы.
(1) script, Наверное, вам больше подойдет . Примерно то же самое, но используется только Power Shell.
Для рядового одноэсника страница из разряда — долго читал, много думал.
(4) Поручик, Для рядового одинесника (да простят меня на сайте — сам такой) много читал и думал — не свойственно. На все мои попытки что-то новое привить мои коллеги обычно отвечают — «Зачем и так деньги платят. Развиваться надо когда делать нечего.»
Данную статью я опубликовал только из-за Артур Аюханов, который плюсанул за нее когда она была в черновом варианте, без описания совсем. Думал отделуюсь коротким хау-ту, ан нет придется писать, что такое ант, что такое доксиген.
(5) Рад, что мой плюсик сработал 🙂
ЗЫ Исправь, пожалуйста, мое ФИО на «Артур Аюханов»
(6) artbear, Прости, не со зла… Стыдно….
Зеркало есть для разработки? А то этих маней нет (и не будет видимо никогда 🙂 )
Вещь хорошая, жаль что мне пока не нужная 🙂
Автору почет и уважение.
(8) so-quest, Да вроде на ассамблее было..
В 1С надо ссылку отправить, может хоть тогда у них документация начнёт соответствовать коду…
(11) wolfsoft, А мы где? Территория инфостарт на половину принадлежит 1С.
Необходимость в документировании, возникает при написании подсистем и работе в команде, я работаю уже много лет соло, да и подсистем не писал никогда. Но плюсану вдруг понадобится 🙂
(13) webester, :))) Необходимость документирования обычно возникает гораздо позже написания (не важно в команде или в подсистеме). Правда возникает не в ста процентов случаев. Вот и получается — когда пишем, то ориентируемся на случай: «Авось не понадобится», а когда переписываем, то материмся на: «Суцко. Таки понадобилось».
(13) Ага, тоже плюсанул «на потом почитать» =)
к сожалению ничего не понял.
(16) значит вам это не нужно 🙂
Стандартные комментарии 1С, преобразовывает в формат doxygen?
Показать
В
// Устанавливает статус для объекта документа // // @param НовыйСтатус — Строка — Имя статуса, который будет установлен у заказов // @param ДополнительныеПараметры {Структура} — Структура дополнительных параметров установки статуса // Функция УстановитьСтатус(НовыйСтатус, ДополнительныеПараметры) Экспорт?
(18) pumbaE, Нет.
а можно дополнить руководство разделом по настройке ANT ? а то сходу не понятно нифига:) да и времени на его подробное изучение нет 🙁
Не работает алгоритм:( Почему-то не конвертируются файлы выгрузки из 1С в файлы java, вот этот пункт из описания: «Второй плагин ни делает ничего, кроме выгрузки модулей 1С и преобразования их в код на подобии java.»
Народ, кто-то вообще пробовал использовать doxygen?
Постоянно сталкиваюсь с ошибкой error: Could not open file Z:/temp/ant21cjava/doc/html/functions_.html for writing после шага Generating member index.
На этом создание документации прерывается и index.html остается пустым, в то время, как остальные файлы сформированы.