Зачем это нужно

Блок-схема - один из самых старых и по-прежнему самых понятных способов описать алгоритм. Она выручает, когда нужно быстро разобраться в чужой процедуре, оставшейся от прошлого разработчика, ввести в проект нового коллегу, объяснить заказчику, как работает ветвление, или приложить к документации схему обмена данными. По хорошо нарисованной схеме логику процедуры понимает даже человек, не пишущий на 1С.

Проблема в другом: рисовать схемы вручную - неблагодарный труд. В Visio или draw.io схема большой процедуры занимает вечер, а после первой же правки кода молча устаревает, и обновлять её обычно никто не берётся. Логичная альтернатива - поручить черчение машине: пусть схема строится по самому тексту модуля и обновляется за считанные секунды, когда код изменился.

Что делает обработка

Внешняя обработка "Блок схемы кода 1С" - как раз такой чертёжник.

• разбирает вставленный текст модуля 1С на процедуры и функции;
• строит блок-схему выбранной процедуры: начало и конец, входные параметры, условия, ветвления и циклы;
• по нажатию кнопки формирует короткие описания блоков - вместо строки кода на схеме появляется её формулировка простым языком;
• масштабирует схему и выгружает её в SVG для документации.

Как открыть обработку

Никакой установки нет. Самый быстрый способ - "Файл - Открыть" и выбор файла обработки. Если хочется, чтобы она была всегда под рукой, подключите её штатно: "Администрирование - Печатные формы, отчёты и обработки - Дополнительные отчёты и обработки". Файл обработки приложен к статье. Регистрация необязательна - можно работать анонимно. Для работы нужны управляемые формы 1С:Предприятия 8.3 в тонком клиенте и доступ в интернет по HTTPS.

После открытия обработка встречает приветственным экраном с краткой инструкцией (рис. 1).

Рис. 1. Форма обработки после открытия.

Шаг 1. Разбираем модуль

Откройте обработку и вставьте текст модуля в левое поле - прямо из конфигуратора или из файла. Над полем ввода стоит напоминание: "Только код 1С. Без паролей, ключей и персональных данных" - прежде чем вставлять, удалите из модуля всё чувствительное. Нажмите "Разобрать модуль". Справа появится список всех процедур и функций модуля с количеством строк. Щёлкните по строке - в центре построится блок-схема выбранной процедуры (рис. 2). Так же, щёлкая по строкам списка, переключайтесь между процедурами; выбранная строка подсвечивается.

Рис. 2. Модуль разобран: список процедур справа, блок-схема выбранной процедуры в центре.

Схема строится по классическим правилам: овалы - начало и конец, параллелограмм - входные параметры, ромб - условие, прямоугольники - действия. На этом этапе в блоках стоит тот же код, что и в модуле, - так удобно проверять разбор.

Шаг 2. Смотрим и выгружаем схему

Кнопки над схемой управляют масштабом: "Вписать" возвращает схему в границы окна, "+" и "−" приближают и отдаляют. "Экспорт SVG" сохраняет схему в векторный файл: он открывается в любом браузере, не теряет чёткость при увеличении и спокойно вставляется в документацию, Confluence или корпоративную вики.

Шаг 3. Формируем описания блоков

Схема с исходным кодом в блоках удобна программисту, но для документации хочется формулировок по-русски. Нажмите "Сформировать описания блоков" - обработка последовательно пройдёт по всем процедурам списка. В центре виден прогресс: какая процедура обрабатывается, сколько выполнено и сколько ошибок; текущая строка подсвечивается в списке (рис. 3).

Рис. 3. Формирование описаний: прогресс и подсветка обрабатываемой процедуры.

По завершении появляется короткий итог (рис. 4), и обработка возвращает схему - теперь в блоках вместо строк кода стоят короткие описания (рис. 5). Такую схему можно смело класть в документацию: чтобы понять ветвление, читателю не нужно знать 1С.

Рис. 4. Описания сформированы.

Рис. 5. Схема после формирования описаний (фрагмент окна).

Требования и ограничения

• 1С:Предприятие 8.3, управляемые формы, тонкий клиент.
• Обработка обращается к онлайн-сервису: вставленный текст модуля передаётся на сервер по HTTPS, там разбирается и превращается в схемы и описания. Локально код не анализируется. Если код нельзя выносить с рабочего места - обработка, к сожалению, не подойдёт.
• На сервере код не сохраняется и в логи не пишется: он используется только для выполнения запроса. Для ускорения повторной работы кэшируются не сами модули, а готовые описания блоков - по ним восстановить исходный код невозможно.
• Модули примерно до 500 строк - более крупные удобно вставлять частями.

В заключение

Если обработка пригодилась - расскажите в комментариях, для каких задач используете и чего не хватает: это правда помогает. О замечаниях удобнее сообщать прямо из обработки - вкладка "Отзыв" в правой части окна. К отзыву можно приложить текст модуля из поля слева - флажком "Приложить исходный текст модуля для отладки"; по умолчанию он выключен, и код уйдёт к автору только если вы сами его включите. Перед отправкой убедитесь, что в коде нет паролей, ключей и персональных данных - те же правила, что и при разборе. Подробная пошаговая инструкция открывается по кнопке "?" в заголовке окна.

Другие публикации и разработки автора

• Анализ использования внешних отчетов и обработок по журналу регистрации

• Массовый экспорт и импорт дополнительных отчетов и обработок (БСП, 8.3)

• Массовая правка модулей внешних обработок через штатный Конфигуратор. 1С 8.3

• Конвертер Markdown для 1С: Word, PDF, HTML, TXT - таблицы, формулы, картинки