Инструмент генерации документации на основании файлов исходных кодов конфигурации 1С:Предприятие.
Инструмент позволяет
- автоматически сформировать документацию на основании исходных файлов конфигурации 1С:Предприятие
- выполнить проверку на возможность корректного разбора информации, выступающей исходными данными для документации
- опубликовать сгенерированную документацию
Процесс установки стандартен:
- либо
opm install autodocgen - либо, если по разным причинам первый способ не подходит, то скачать архив из релизов, распаковать и выполнить (для windows)
installlocalhost.bat
Основные возможности есть в справке. Отдельно стоит обратить внимание на конфигурационный файл.
Конфигурационный файл соответствует структуре единого конфигурационного файла, ниже приведен пример
{
"GLOBAL": {
"КаталогИсходныхФайлов": "src\\configuration",
"version": "1.0.2"
},
"AutodocGen":{
"НастройкиConluence": {
"АдресСервера":"https://my-confluence.myhost.ru",
"Пользователь":"user",
"Пароль":"password",
"Пространство":"key",
"КорневаяСтраница":"Имя кореневой страницы в пространстве key",
"ПутьКШаблонам": "",
"АнализироватьТолькоПотомковПодсистемы": "МояКорневаяПодсистема"
},
"НастройкиHTML": {
"ПутьКШаблонам": "",
"КаталогПубликации": "./doc",
"АнализироватьТолькоПотомковПодсистемы": "МояКорневаяПодсистема"
},
"ПоследнийОбработанныйКоммит": ""
}
}Располагать конфигурационный файл нужно в корне репозитория под именем v8config.json.
Как видно из пример конфигурационного файла, поддерживаются 2 формата (ключ -format)
confluence- генерация страниц в указанном пространстве confluencehtml- генерация структуры каталогов в соответствии с подсистемами и файлов-страниц в каталогах.
Для добавления новых стоит воспользоваться шаблоном src/Классы/ШаблонГенераторДокументации.os-template
Для генерации документации конфигурация должна соответствовать требованиям:
- Все модули должны иметь определенную структуру областей (в соответствии с требованиями 1С)
- В документацию добавляются только экспортные методы, находящиеся в разделе
ПрограммныйИнтерфейс - Описание методов должно соответствовать требованиям оформления кода
- Поддерживаются общие модуи и модули менеджеров объектов
- Все модули / объекты, которые попадают под правила автодокументирования, должны располагаться в соответствующих подсистемах. Принятая структура:
Подсистемы конфигурации
|
+-- МояКорневаяПодсистема (не выводится в интерфейс пользователя)
|
+-- Раздел
|
+-- Подсистема
|
+-- ОбъектМетаданных
