Каждый опытный разработчик 1С со временем накапливает огромный багаж готовых решений, уникальных фрагментов кода и инструкций, которые необходимо иметь под рукой. Особенно это актуально при работе на выезде у клиента, где может отсутствовать стабильный доступ к интернету или внутренним ресурсам компании. В данной статье мы подробно рассмотрим, какими технологиями можно воспользоваться для создания персональной справочной системы, которая будет работать полностью автономно.
Начнем с наиболее близких разработчику инструментов, интегрированных непосредственно в платформу. Одним из самых эффективных способов хранения кода являются файлы шаблонов текста с расширением .st. Рассмотрим подробнее, как этот механизм помогает в документировании.
Файлы шаблонов позволяют не просто хранить текст, но и мгновенно вставлять его в модуль через автоподстановку. Разберем по шагам, как организовать такую базу:
Важным преимуществом является то, что файл gentempl_ru.st или любой ваш пользовательский файл шаблонов можно легко скопировать на флешку и подключить в конфигураторе на любом рабочем месте. Проанализируем также формат .hbk (Help Book). Это профессиональный формат справочных систем 1С, который позволяет создавать иерархическую структуру разделов с поддержкой форматированного текста и поиска. Хотя создание таких файлов требует определенных усилий по оформлению, они выглядят как родная справка 1С и максимально органично вписываются в среду разработки.
Если нам нужна универсальность, чтобы справка открывалась на любой операционной системе без установленной платформы 1С, стоит обратить внимание на HTML. Это самый гибкий формат для документирования программного кода. Проанализируем ситуацию: HTML-файл открывается в любом браузере, поддерживает гиперссылки и, что самое важное, позволяет внедрять скрипты для подсветки синтаксиса 1С.
Для создания такой системы мы рекомендуем использовать подход Static Site Generators (SSG) или специализированные Wiki-движки, состоящие из одного файла. Рассмотрим пример TiddlyWiki. Это уникальное решение, представляющее собой один-единственный HTML-файл, в котором находится и база данных заметок, и интерфейс для их редактирования. Вы просто сохраняете этот файл на флешку, и ваша база знаний всегда с вами.
Если же вы предпочитаете современный формат Markdown, разберем возможности программы Obsidian. Это мощная среда для ведения заметок, которая хранит все данные в обычных текстовых файлах. Для программиста 1С это удобно по нескольким причинам:
.md, которые можно читать даже обычным блокнотом.Довольно логично использовать инструмент, в котором мы работаем, для хранения документации по нему же. Мы можем создать простую файловую базу данных на платформе 1С. Посмотрим на пример структуры такой конфигурации:
Для отображения программного кода в пользовательском режиме можно использовать поле текстового документа. Выясним причину, почему это удобно: в 1С есть встроенный редактор с подсветкой синтаксиса. Рассмотрим программный фрагмент для вывода текста в форму:
// Пример инициализации текстового редактора для отображения кода
ЭлементТекст = ЭтаФорма.Элементы.ТекстКода;
ЭлементТекст.УстановитьТекст(ТекущаяЗапись.ПрограммныйКод);
ЭлементТекст.ОбновлениеОтображения();
Такую базу легко носить с собой на флешке. Поскольку у клиента почти всегда установлена платформа 1С, вам достаточно просто подключить файловую базу из папки. Если же вы опасаетесь отсутствия платформы, можно использовать мобильное приложение 1С, синхронизированное с вашей основной базой знаний.
Не стоит забывать и о методике "самодокументированного кода". Давайте проанализируем подход, при котором основные знания фиксируются прямо в модулях 1С. При создании новых объектов или функций крайне важно соблюдать стандарты оформления комментариев. Это позволяет в будущем автоматически генерировать справку.
Например, использование стандартизированных описаний функций:
// Осуществляет расчет стоимости товаров с учетом скидок.
//
// Параметры:
// МассивТоваров - Массив - список объектов для расчета.
// СтруктураСкидок - Структура - параметры применяемых скидок.
//
// Возвращаемое значение:
// Число - итоговая сумма.
//
Функция РассчитатьСтоимость(МассивТоваров, СтруктураСкидок) Экспорт
// Реализация алгоритма
КонецФункции
Существуют инструменты, которые могут "вытягивать" такие комментарии из метаданных конфигурации и преобразовывать их в структурированные файлы справки или даже в разделы Синтакс-помощника. Это позволяет держать техническую документацию максимально близко к исполняемому коду.
Подводя итог нашему разбору, выделим критерии выбора технологии для вашей переносной справки:
.st..hbk.Мы рекомендуем комбинированный подход: хранить короткие сниппеты в шаблонах конфигуратора для оперативной работы, а сложные архитектурные решения и инструкции описывать в системе на базе Markdown. Это обеспечит вам максимальную эффективность как при написании кода, так и при поиске сложных решений в условиях ограниченного доступа к сети.