Многопользовательская разработка конфигурации

Общие положения работы с хранилищем конфигурации

Для одновременной разработки одной конфигурации коллективом разработчиков необходимо использовать хранилище конфигурации.

Все разработчики конфигурации подключаются к хранилищу и ведут разработку, получая из хранилища текущее состояние конфигурации, захватывая объекты для внесения изменений и помещая изменения в хранилище.
Хранилище:
- дает право на изменение одного объекта метаданных в один момент времени только одному разработчику
- хранит текущие результаты и историю коллективной работы разработчиков
- позволяет построить отчет об изменениях, внесенных в конфигурацию.

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

Запрещается при разработке конфигурации нарушать последовательность "захват в хранилище - внесение изменений – помещение в хранилище". Любой объект, который необходимо модифицировать, должен быть перед этим обязательно захвачен в хранилище. Поэтому крайне не рекомендуется в целях разработки конфигурации создавать какие-либо копии объектов метаданных, помимо конфигурации, подключенной к хранилищу и автоматически запрещающей изменять не захваченные в хранилище объекты. В частности, не рекомендуется вести какую-либо разработку в конфигурации, не связанной с хранилищем, захватывая в хранилище объекты только в момент помещения туда результатов работы.

Запрещается при разработке конфигурации удалять объекты метаданных временно, с последующим пересозданием удаленного объекта с тем же именем. Пересоздание любых объектов создает впоследствии трудности с поддержкой конфигурации. В частности, запрещается при разработке конфигурации использовать прием, когда для разработки создается копия объекта метаданных (например, формы), которая дорабатывается, отлаживается, после чего исходный объект удаляется, а копии присваивается имя исходного объекта.

Комментарии к версиям хранилища конфигурации

При помещении очередной версии конфигурации в хранилище конфигурации разработчик обязательно должен написать комментарий к версии хранилища.

Комментарий к версии хранилища должен быть написан понятным языком, не содержать сленга, грамматических и синтаксических ошибок. Комментарий должен кратко, без излишеств, но точно описывать суть внесенных изменений.

Если для учета ошибок и задач по разработке конфигурации ведется специализированная информационная база, то в первой строке комментария указывается код задачи (ошибка), изменения по которой вносятся в текущую версию хранилища конфигурации, в виде:
// NNNNN

На следующей строке указывается текст одного из двух видов: «Исправлено:» или «Исправлена ошибка:», в зависимости от вида задачи "Задача" или "Ошибка" соответственно.

Ниже пишется сам текст комментария.

Никакой другой информации указывать не требуется.

Следует помнить, что текст комментария, в общем случае, предназначен для чтения партнерами и пользователями. Текст комментария включается в отчет по хранилищу, а сам отчет включается в состав версии конфигурации.

В случае, когда приходится помещать в хранилище вносимые в рамках одного исправления изменения и доработки в несколько приемов, создавая, таким образом, несколько версий конфигурации, необходимо указывать полностью идентичный комментарий ко всем таким версиям.

Существует возможность исключать комментарий или его часть из отчета по хранилищу.
Исключить можно либо целиком одну или несколько строк, либо часть строки до конца.

Строки комментария, которые не должны включаться в отчет по хранилищу, выделяются символами // (два слеша) в начале строки.

Если символы // располагаются где-то в середине строки, в отчет по хранилищу не будет включаться часть строки от символов «//» до конца строки.

При составлении комментариев следует иметь в виду одну особенность.
В состав версии конфигурации входит файл «Новое в версии», в который включаются комментарии из отчета по хранилищу. При этом список измененных объектов в файл «Новое в версии» не входит. Из-за этого иногда бывает не понятно – о каком объекте конфигурации идет речь в описании изменений. Поэтому при составлении комментариев необходимо включать в него название объекта (объектов) метаданных.

Если объектов не очень много, их названия следует давать так, как они указаны пользовательском интерфейсе.
Если объектов много, достаточно общее упоминание, например: «Для всех документов подсистемы «Заказы» сделано то-то и то-то».

При написании комментария к закладке в хранилище конфигурации не надо разделать текст переводом строк, за исключением случаев разделения текста на абзацы. При этом каждый абзац необходимо начинать символами "//".