|
|||||||
Время создания: 08.09.2016 17:56
Автор: Казьмин Василий aka awk
Текстовые метки: 1c.documentation
Раздел: Программирование - 1с - Documentation
Запись: xintrea/mytetra_anatolean/raw/master/base/1473346576xbd5durnov/text.html на bitbucket.org
|
|||||||
|
|||||||
Для языков программирования Java, C++, C# и т.д. Созданы системы строящие документацию, через комментарии. А можно ли такое же в 1С? Можно. Для этого потребуется:
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. Итог Вуаля документация у вас готова. |
|||||||
![]() |
|||||||
|
|||||||
|